@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
package/lib/seam/connect/openapi.js CHANGED
@@ -37,885 +37,784 @@ export default {
37
37
  errors: {
38
38
  description: '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.',
39
39
  items: {
40
+ discriminator: { propertyName: 'error_code' },
40
41
  oneOf: [
41
42
  {
42
- oneOf: [
43
- {
44
- description: 'Failed to set code on Smart Things device.',
45
- properties: {
46
- error_code: {
47
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
48
- enum: ['smartthings_failed_to_set_access_code'],
49
- type: 'string',
50
- },
51
- is_access_code_error: { enum: [true], type: 'boolean' },
52
- message: { type: 'string' },
53
- },
54
- required: [
55
- 'message',
56
- 'is_access_code_error',
57
- 'error_code',
58
- ],
59
- type: 'object',
60
- },
61
- {
62
- description: 'Failed to set code after multiple retries.',
63
- properties: {
64
- error_code: {
65
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
66
- enum: [
67
- 'smartthings_failed_to_set_after_multiple_retries',
68
- ],
69
- type: 'string',
70
- },
71
- is_access_code_error: { enum: [true], type: 'boolean' },
72
- message: { type: 'string' },
73
- },
74
- required: [
75
- 'message',
76
- 'is_access_code_error',
77
- 'error_code',
78
- ],
79
- type: 'object',
43
+ description: 'Failed to set code on Smart Things device.',
44
+ properties: {
45
+ error_code: {
46
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
47
+ enum: ['smartthings_failed_to_set_access_code'],
48
+ type: 'string',
80
49
  },
81
- {
82
- description: 'Failed to set code on device.',
83
- properties: {
84
- error_code: {
85
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
86
- enum: ['failed_to_set_on_device'],
87
- type: 'string',
88
- },
89
- is_access_code_error: { enum: [true], type: 'boolean' },
90
- message: { type: 'string' },
91
- },
92
- required: [
93
- 'message',
94
- 'is_access_code_error',
95
- 'error_code',
50
+ is_access_code_error: { enum: [true], type: 'boolean' },
51
+ message: { type: 'string' },
52
+ },
53
+ required: ['message', 'is_access_code_error', 'error_code'],
54
+ type: 'object',
55
+ },
56
+ {
57
+ description: 'Failed to set code after multiple retries.',
58
+ properties: {
59
+ error_code: {
60
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
61
+ enum: [
62
+ 'smartthings_failed_to_set_after_multiple_retries',
96
63
  ],
97
- type: 'object',
64
+ type: 'string',
98
65
  },
99
- {
100
- description: 'Failed to remove code from device.',
101
- properties: {
102
- error_code: {
103
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
104
- enum: ['failed_to_remove_from_device'],
105
- type: 'string',
106
- },
107
- is_access_code_error: { enum: [true], type: 'boolean' },
108
- message: { type: 'string' },
109
- },
110
- required: [
111
- 'message',
112
- 'is_access_code_error',
113
- 'error_code',
114
- ],
115
- type: 'object',
66
+ is_access_code_error: { enum: [true], type: 'boolean' },
67
+ message: { type: 'string' },
68
+ },
69
+ required: ['message', 'is_access_code_error', 'error_code'],
70
+ type: 'object',
71
+ },
72
+ {
73
+ description: 'Failed to set code on device.',
74
+ properties: {
75
+ error_code: {
76
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
77
+ enum: ['failed_to_set_on_device'],
78
+ type: 'string',
116
79
  },
117
- {
118
- description: 'Duplicate access code detected on device.',
119
- properties: {
120
- error_code: {
121
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
122
- enum: ['duplicate_code_on_device'],
123
- type: 'string',
124
- },
125
- is_access_code_error: { enum: [true], type: 'boolean' },
126
- message: { type: 'string' },
127
- },
128
- required: [
129
- 'message',
130
- 'is_access_code_error',
131
- 'error_code',
132
- ],
133
- type: 'object',
80
+ is_access_code_error: { enum: [true], type: 'boolean' },
81
+ message: { type: 'string' },
82
+ },
83
+ required: ['message', 'is_access_code_error', 'error_code'],
84
+ type: 'object',
85
+ },
86
+ {
87
+ description: 'Failed to remove code from device.',
88
+ properties: {
89
+ error_code: {
90
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
91
+ enum: ['failed_to_remove_from_device'],
92
+ type: 'string',
134
93
  },
135
- {
136
- description: 'An attempt to modify this access code was prevented.',
137
- properties: {
138
- error_code: {
139
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
140
- enum: ['duplicate_code_attempt_prevented'],
141
- type: 'string',
142
- },
143
- is_access_code_error: { enum: [true], type: 'boolean' },
144
- message: { type: 'string' },
145
- },
146
- required: [
147
- 'message',
148
- 'is_access_code_error',
149
- 'error_code',
150
- ],
151
- type: 'object',
94
+ is_access_code_error: { enum: [true], type: 'boolean' },
95
+ message: { type: 'string' },
96
+ },
97
+ required: ['message', 'is_access_code_error', 'error_code'],
98
+ type: 'object',
99
+ },
100
+ {
101
+ description: 'Duplicate access code detected on device.',
102
+ properties: {
103
+ error_code: {
104
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
105
+ enum: ['duplicate_code_on_device'],
106
+ type: 'string',
152
107
  },
153
- {
154
- description: 'Igloohome bridge has too many pending jobs in the queue.',
155
- properties: {
156
- error_code: {
157
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
158
- enum: ['igloohome_bridge_too_many_pending_jobs'],
159
- type: 'string',
160
- },
161
- is_access_code_error: { enum: [true], type: 'boolean' },
162
- message: { type: 'string' },
163
- },
164
- required: [
165
- 'message',
166
- 'is_access_code_error',
167
- 'error_code',
168
- ],
169
- type: 'object',
108
+ is_access_code_error: { enum: [true], type: 'boolean' },
109
+ message: { type: 'string' },
110
+ },
111
+ required: ['message', 'is_access_code_error', 'error_code'],
112
+ type: 'object',
113
+ },
114
+ {
115
+ description: 'An attempt to modify this access code was prevented.',
116
+ properties: {
117
+ error_code: {
118
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
119
+ enum: ['duplicate_code_attempt_prevented'],
120
+ type: 'string',
170
121
  },
171
- {
172
- description: 'Igloohome bridge is offline.',
173
- properties: {
174
- error_code: {
175
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
176
- enum: ['igloohome_bridge_offline'],
177
- type: 'string',
178
- },
179
- is_access_code_error: { enum: [true], type: 'boolean' },
180
- message: { type: 'string' },
181
- },
182
- required: [
183
- 'message',
184
- 'is_access_code_error',
185
- 'error_code',
186
- ],
187
- type: 'object',
122
+ is_access_code_error: { enum: [true], type: 'boolean' },
123
+ message: { type: 'string' },
124
+ },
125
+ required: ['message', 'is_access_code_error', 'error_code'],
126
+ type: 'object',
127
+ },
128
+ {
129
+ description: 'Igloohome bridge has too many pending jobs in the queue.',
130
+ properties: {
131
+ error_code: {
132
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
133
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
134
+ type: 'string',
188
135
  },
189
- {
190
- description: 'Lock as reached max amount of codes.',
191
- properties: {
192
- error_code: {
193
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
194
- enum: [
195
- 'igloohome_offline_access_code_no_variance_available',
196
- ],
197
- type: 'string',
198
- },
199
- is_access_code_error: { enum: [true], type: 'boolean' },
200
- message: { type: 'string' },
201
- },
202
- required: [
203
- 'message',
204
- 'is_access_code_error',
205
- 'error_code',
206
- ],
207
- type: 'object',
136
+ is_access_code_error: { enum: [true], type: 'boolean' },
137
+ message: { type: 'string' },
138
+ },
139
+ required: ['message', 'is_access_code_error', 'error_code'],
140
+ type: 'object',
141
+ },
142
+ {
143
+ description: 'Igloohome bridge is offline.',
144
+ properties: {
145
+ error_code: {
146
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
147
+ enum: ['igloohome_bridge_offline'],
148
+ type: 'string',
208
149
  },
209
- {
210
- description: 'Unable to confirm the access code is set on Kwikset device.',
211
- properties: {
212
- error_code: {
213
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
214
- enum: ['kwikset_unable_to_confirm_code'],
215
- type: 'string',
216
- },
217
- is_access_code_error: { enum: [true], type: 'boolean' },
218
- message: { type: 'string' },
219
- },
220
- required: [
221
- 'message',
222
- 'is_access_code_error',
223
- 'error_code',
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: 'Lock as reached max amount of codes.',
158
+ properties: {
159
+ error_code: {
160
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
161
+ enum: [
162
+ 'igloohome_offline_access_code_no_variance_available',
224
163
  ],
225
- type: 'object',
164
+ type: 'string',
226
165
  },
227
- {
228
- description: 'Unable to confirm the deletion of the access code on Kwikset device.',
229
- properties: {
230
- error_code: {
231
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
232
- enum: ['kwikset_unable_to_confirm_deletion'],
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',
166
+ is_access_code_error: { enum: [true], type: 'boolean' },
167
+ message: { type: 'string' },
168
+ },
169
+ required: ['message', 'is_access_code_error', 'error_code'],
170
+ type: 'object',
171
+ },
172
+ {
173
+ description: 'Unable to confirm the access code is set on Kwikset device.',
174
+ properties: {
175
+ error_code: {
176
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
177
+ enum: ['kwikset_unable_to_confirm_code'],
178
+ type: 'string',
244
179
  },
245
- {
246
- description: 'Code was modified or removed externally after Seam successfully set it on the device.',
247
- properties: {
248
- error_code: {
249
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
250
- enum: ['code_modified_external_to_seam'],
251
- type: 'string',
252
- },
253
- is_access_code_error: { enum: [true], type: 'boolean' },
254
- message: { type: 'string' },
255
- },
256
- required: [
257
- 'message',
258
- 'is_access_code_error',
259
- 'error_code',
260
- ],
261
- type: 'object',
180
+ is_access_code_error: { enum: [true], type: 'boolean' },
181
+ message: { type: 'string' },
182
+ },
183
+ required: ['message', 'is_access_code_error', 'error_code'],
184
+ type: 'object',
185
+ },
186
+ {
187
+ description: 'Unable to confirm the deletion of the access code on Kwikset device.',
188
+ properties: {
189
+ error_code: {
190
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
191
+ enum: ['kwikset_unable_to_confirm_deletion'],
192
+ type: 'string',
262
193
  },
263
- {
264
- description: 'Invalid code length for August lock.',
265
- properties: {
266
- error_code: {
267
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
268
- enum: ['august_lock_invalid_code_length'],
269
- type: 'string',
270
- },
271
- is_access_code_error: { enum: [true], type: 'boolean' },
272
- message: { type: 'string' },
273
- },
274
- required: [
275
- 'message',
276
- 'is_access_code_error',
277
- 'error_code',
278
- ],
279
- type: 'object',
194
+ is_access_code_error: { enum: [true], type: 'boolean' },
195
+ message: { type: 'string' },
196
+ },
197
+ required: ['message', 'is_access_code_error', 'error_code'],
198
+ type: 'object',
199
+ },
200
+ {
201
+ description: 'Code was modified or removed externally after Seam successfully set it on the device.',
202
+ properties: {
203
+ error_code: {
204
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
205
+ enum: ['code_modified_external_to_seam'],
206
+ type: 'string',
280
207
  },
281
- {
282
- description: 'Access code has not yet been fully moved to the device.',
283
- properties: {
284
- error_code: {
285
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
286
- enum: ['august_device_programming_delay'],
287
- type: 'string',
288
- },
289
- is_access_code_error: { enum: [true], type: 'boolean' },
290
- message: { type: 'string' },
291
- },
292
- required: [
293
- 'message',
294
- 'is_access_code_error',
295
- 'error_code',
296
- ],
297
- type: 'object',
208
+ is_access_code_error: { enum: [true], type: 'boolean' },
209
+ message: { type: 'string' },
210
+ },
211
+ required: ['message', 'is_access_code_error', 'error_code'],
212
+ type: 'object',
213
+ },
214
+ {
215
+ description: 'Invalid code length for August lock.',
216
+ properties: {
217
+ error_code: {
218
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
219
+ enum: ['august_lock_invalid_code_length'],
220
+ type: 'string',
298
221
  },
299
- {
300
- description: 'All access code slots on the device are full.',
301
- properties: {
302
- error_code: {
303
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
304
- enum: ['august_device_slots_full'],
305
- type: 'string',
306
- },
307
- is_access_code_error: { enum: [true], type: 'boolean' },
308
- message: { type: 'string' },
309
- },
310
- required: [
311
- 'message',
312
- 'is_access_code_error',
313
- 'error_code',
314
- ],
315
- type: 'object',
222
+ is_access_code_error: { enum: [true], type: 'boolean' },
223
+ message: { type: 'string' },
224
+ },
225
+ required: ['message', 'is_access_code_error', 'error_code'],
226
+ type: 'object',
227
+ },
228
+ {
229
+ description: 'Access code has not yet been fully moved to the device.',
230
+ properties: {
231
+ error_code: {
232
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
233
+ enum: ['august_device_programming_delay'],
234
+ type: 'string',
316
235
  },
317
- {
318
- description: 'August lock is missing a keypad.',
319
- properties: {
320
- error_code: {
321
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
322
- enum: ['august_lock_missing_keypad'],
323
- type: 'string',
324
- },
325
- is_access_code_error: { enum: [true], type: 'boolean' },
326
- message: { type: 'string' },
327
- },
328
- required: [
329
- 'message',
330
- 'is_access_code_error',
331
- 'error_code',
332
- ],
333
- type: 'object',
236
+ is_access_code_error: { enum: [true], type: 'boolean' },
237
+ message: { type: 'string' },
238
+ },
239
+ required: ['message', 'is_access_code_error', 'error_code'],
240
+ type: 'object',
241
+ },
242
+ {
243
+ description: 'All access code slots on the device are full.',
244
+ properties: {
245
+ error_code: {
246
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
247
+ enum: ['august_device_slots_full'],
248
+ type: 'string',
334
249
  },
335
- {
336
- description: 'Salto site user is not subscribed.',
337
- properties: {
338
- error_code: {
339
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
340
- enum: ['salto_site_user_not_subscribed'],
341
- type: 'string',
342
- },
343
- is_access_code_error: { enum: [true], type: 'boolean' },
344
- message: { type: 'string' },
345
- },
346
- required: [
347
- 'message',
348
- 'is_access_code_error',
349
- 'error_code',
350
- ],
351
- type: 'object',
352
- },
353
- {
354
- description: 'Access code has not yet been fully moved to the device.',
355
- properties: {
356
- error_code: {
357
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
358
- enum: ['hubitat_device_programming_delay'],
359
- type: 'string',
360
- },
361
- is_access_code_error: { enum: [true], type: 'boolean' },
362
- message: { type: 'string' },
363
- },
364
- required: [
365
- 'message',
366
- 'is_access_code_error',
367
- 'error_code',
368
- ],
369
- type: 'object',
370
- },
371
- {
372
- description: 'No free positions available on the device.',
373
- properties: {
374
- error_code: {
375
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
376
- enum: ['hubitat_no_free_positions_available'],
377
- type: 'string',
378
- },
379
- is_access_code_error: { enum: [true], type: 'boolean' },
380
- message: { type: 'string' },
381
- },
382
- required: [
383
- 'message',
384
- 'is_access_code_error',
385
- 'error_code',
386
- ],
387
- type: 'object',
388
- },
389
- ],
390
- },
391
- {
392
- description: 'Error associated with the `device`.',
393
- oneOf: [
394
- {
395
- description: 'Device is offline',
396
- properties: {
397
- error_code: {
398
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
399
- enum: ['device_offline'],
400
- type: 'string',
401
- },
402
- is_device_error: { enum: [true], type: 'boolean' },
403
- message: { type: 'string' },
404
- },
405
- required: ['message', 'is_device_error', 'error_code'],
406
- type: 'object',
407
- },
408
- {
409
- description: 'Device has been removed',
410
- properties: {
411
- error_code: {
412
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
413
- enum: ['device_removed'],
414
- type: 'string',
415
- },
416
- is_device_error: { enum: [true], type: 'boolean' },
417
- message: { type: 'string' },
418
- },
419
- required: ['message', 'is_device_error', 'error_code'],
420
- type: 'object',
421
- },
422
- {
423
- description: 'Account is disconnected',
424
- properties: {
425
- error_code: {
426
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
427
- enum: ['account_disconnected'],
428
- type: 'string',
429
- },
430
- is_device_error: { enum: [true], type: 'boolean' },
431
- message: { type: 'string' },
432
- },
433
- required: ['message', 'is_device_error', 'error_code'],
434
- type: 'object',
435
- },
436
- {
437
- description: 'Hub is disconnected',
438
- properties: {
439
- error_code: {
440
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
441
- enum: ['hub_disconnected'],
442
- type: 'string',
443
- },
444
- is_device_error: { enum: [true], type: 'boolean' },
445
- message: { type: 'string' },
446
- },
447
- required: ['message', 'is_device_error', 'error_code'],
448
- type: 'object',
449
- },
450
- {
451
- description: 'Device is disconnected',
452
- properties: {
453
- error_code: {
454
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
455
- enum: ['device_disconnected'],
456
- type: 'string',
457
- },
458
- is_device_error: { enum: [true], type: 'boolean' },
459
- message: { type: 'string' },
460
- },
461
- required: ['message', 'is_device_error', 'error_code'],
462
- type: 'object',
463
- },
464
- {
465
- description: 'The backup access code pool is empty.',
466
- properties: {
467
- error_code: {
468
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
469
- enum: ['empty_backup_access_code_pool'],
470
- type: 'string',
471
- },
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: 'User is not authorized to use the August Lock.',
480
- properties: {
481
- error_code: {
482
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
483
- enum: ['august_lock_not_authorized'],
484
- type: 'string',
485
- },
486
- is_device_error: { enum: [true], type: 'boolean' },
487
- message: { type: 'string' },
488
- },
489
- required: ['message', 'is_device_error', 'error_code'],
490
- type: 'object',
491
- },
492
- {
493
- description: 'Lock is not connected to the Seam Bridge.',
494
- properties: {
495
- error_code: {
496
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
497
- enum: ['august_lock_missing_bridge'],
498
- type: 'string',
499
- },
500
- is_device_error: { enum: [true], type: 'boolean' },
501
- message: { type: 'string' },
502
- },
503
- required: ['message', 'is_device_error', 'error_code'],
504
- type: 'object',
505
- },
506
- {
507
- description: 'Salto site user limit reached.',
508
- properties: {
509
- error_code: {
510
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
511
- enum: ['salto_site_user_limit_reached'],
512
- type: 'string',
513
- },
514
- is_device_error: { enum: [true], type: 'boolean' },
515
- message: { type: 'string' },
516
- },
517
- required: ['message', 'is_device_error', 'error_code'],
518
- type: 'object',
519
- },
520
- {
521
- description: 'Lock is not paired with a Gateway.',
522
- properties: {
523
- error_code: {
524
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
525
- enum: ['ttlock_lock_not_paired_to_gateway'],
526
- type: 'string',
527
- },
528
- is_device_error: { enum: [true], type: 'boolean' },
529
- message: { type: 'string' },
530
- },
531
- required: ['message', 'is_device_error', 'error_code'],
532
- type: 'object',
533
- },
534
- {
535
- description: 'Missing device credentials.',
536
- properties: {
537
- error_code: {
538
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
539
- enum: ['missing_device_credentials'],
540
- type: 'string',
541
- },
542
- is_device_error: { enum: [true], type: 'boolean' },
543
- message: { type: 'string' },
544
- },
545
- required: ['message', 'is_device_error', 'error_code'],
546
- type: 'object',
547
- },
548
- {
549
- description: 'The auxiliary heat is running.',
550
- properties: {
551
- error_code: {
552
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
553
- enum: ['auxiliary_heat_running'],
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',
561
- },
562
- {
563
- description: 'Subscription required to connect.',
564
- properties: {
565
- error_code: {
566
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
567
- enum: ['subscription_required'],
568
- type: 'string',
569
- },
570
- is_device_error: { enum: [true], type: 'boolean' },
571
- message: { type: 'string' },
572
- },
573
- required: ['message', 'is_device_error', 'error_code'],
574
- type: 'object',
575
- },
576
- ],
250
+ is_access_code_error: { enum: [true], type: 'boolean' },
251
+ message: { type: 'string' },
252
+ },
253
+ required: ['message', 'is_access_code_error', 'error_code'],
254
+ type: 'object',
577
255
  },
578
256
  {
579
- oneOf: [
580
- {
581
- description: 'Account is disconnected.',
582
- properties: {
583
- error_code: {
584
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
585
- enum: ['account_disconnected'],
586
- type: 'string',
587
- },
588
- is_connected_account_error: {
589
- enum: [true],
590
- type: 'boolean',
591
- },
592
- message: { type: 'string' },
593
- },
594
- required: [
595
- 'message',
596
- 'is_connected_account_error',
597
- 'error_code',
598
- ],
599
- type: 'object',
600
- },
601
- {
602
- description: 'Credentials provided were invalid.',
603
- properties: {
604
- error_code: {
605
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
606
- enum: ['invalid_credentials'],
607
- type: 'string',
608
- },
609
- is_connected_account_error: {
610
- enum: [true],
611
- type: 'boolean',
612
- },
613
- message: { type: 'string' },
614
- },
615
- required: [
616
- 'message',
617
- 'is_connected_account_error',
618
- 'error_code',
619
- ],
620
- type: 'object',
257
+ description: 'August lock is missing a keypad.',
258
+ properties: {
259
+ error_code: {
260
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
261
+ enum: ['august_lock_missing_keypad'],
262
+ type: 'string',
621
263
  },
622
- ],
264
+ is_access_code_error: { enum: [true], type: 'boolean' },
265
+ message: { type: 'string' },
266
+ },
267
+ required: ['message', 'is_access_code_error', 'error_code'],
268
+ type: 'object',
623
269
  },
624
- ],
625
- },
626
- type: 'array',
627
- },
628
- is_backup: {
629
- description: 'Indicates whether the access code is a backup code.',
630
- type: 'boolean',
631
- },
632
- is_backup_access_code_available: {
633
- description: 'Indicates whether a backup access code is available for use if the primary access code is lost or compromised.',
634
- type: 'boolean',
635
- },
636
- is_external_modification_allowed: {
637
- description: 'Indicates whether changes to the access code from external sources are permitted.',
638
- type: 'boolean',
639
- },
640
- is_managed: {
641
- description: 'Indicates whether Seam manages the access code.',
642
- enum: [true],
643
- type: 'boolean',
644
- },
645
- is_offline_access_code: {
646
- description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
647
- type: 'boolean',
648
- },
649
- is_one_time_use: {
650
- description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
651
- type: 'boolean',
652
- },
653
- is_scheduled_on_device: {
654
- description: 'Indicates whether the code is set on the device according to a preconfigured schedule.',
655
- type: 'boolean',
656
- },
657
- is_waiting_for_code_assignment: {
658
- description: 'Indicates whether the access code is waiting for a code assignment.',
659
- type: 'boolean',
660
- },
661
- name: {
662
- description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
663
- nullable: true,
664
- type: 'string',
665
- },
666
- pulled_backup_access_code_id: {
667
- description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.',
668
- format: 'uuid',
669
- nullable: true,
670
- type: 'string',
671
- },
672
- starts_at: {
673
- description: 'Date and time at which the time-bound access code becomes active.',
674
- format: 'date-time',
675
- nullable: true,
676
- type: 'string',
677
- },
678
- status: {
679
- description: '\n Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.\n ',
680
- enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
681
- type: 'string',
682
- },
683
- type: {
684
- description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
685
- enum: ['time_bound', 'ongoing'],
686
- type: 'string',
687
- },
688
- warnings: {
689
- description: '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.',
690
- items: {
691
- oneOf: [
692
270
  {
693
- description: 'Failed to set code on Smart Things device.',
271
+ description: 'Salto site user is not subscribed.',
694
272
  properties: {
695
- message: { type: 'string' },
696
- warning_code: {
697
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
698
- enum: ['smartthings_failed_to_set_access_code'],
273
+ error_code: {
274
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
275
+ enum: ['salto_site_user_not_subscribed'],
699
276
  type: 'string',
700
277
  },
278
+ is_access_code_error: { enum: [true], type: 'boolean' },
279
+ message: { type: 'string' },
701
280
  },
702
- required: ['message', 'warning_code'],
281
+ required: ['message', 'is_access_code_error', 'error_code'],
703
282
  type: 'object',
704
283
  },
705
284
  {
706
- description: 'Duplicate access code detected.',
285
+ description: 'Access code has not yet been fully moved to the device.',
707
286
  properties: {
708
- message: { type: 'string' },
709
- warning_code: {
710
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
711
- enum: ['schlage_detected_duplicate'],
287
+ error_code: {
288
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
289
+ enum: ['hubitat_device_programming_delay'],
712
290
  type: 'string',
713
291
  },
292
+ is_access_code_error: { enum: [true], type: 'boolean' },
293
+ message: { type: 'string' },
714
294
  },
715
- required: ['message', 'warning_code'],
295
+ required: ['message', 'is_access_code_error', 'error_code'],
716
296
  type: 'object',
717
297
  },
718
298
  {
719
- description: 'Received an error when attempting to create this code.',
299
+ description: 'No free positions available on the device.',
720
300
  properties: {
721
- message: { type: 'string' },
722
- warning_code: {
723
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
724
- enum: ['schlage_creation_outage'],
301
+ error_code: {
302
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
303
+ enum: ['hubitat_no_free_positions_available'],
725
304
  type: 'string',
726
305
  },
306
+ is_access_code_error: { enum: [true], type: 'boolean' },
307
+ message: { type: 'string' },
727
308
  },
728
- required: ['message', 'warning_code'],
309
+ required: ['message', 'is_access_code_error', 'error_code'],
729
310
  type: 'object',
730
311
  },
731
312
  {
732
- description: 'Code was modified or removed externally after Seam successfully set it on the device.',
313
+ description: 'Device is offline',
733
314
  properties: {
734
- message: { type: 'string' },
735
- warning_code: {
736
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
737
- enum: ['code_modified_external_to_seam'],
315
+ error_code: {
316
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
317
+ enum: ['device_offline'],
738
318
  type: 'string',
739
319
  },
320
+ is_device_error: { enum: [true], type: 'boolean' },
321
+ message: { type: 'string' },
740
322
  },
741
- required: ['message', 'warning_code'],
323
+ required: ['message', 'is_device_error', 'error_code'],
742
324
  type: 'object',
743
325
  },
744
326
  {
745
- description: 'Delay in setting code on device.',
327
+ description: 'Device has been removed',
746
328
  properties: {
747
- message: { type: 'string' },
748
- warning_code: {
749
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
750
- enum: ['delay_in_setting_on_device'],
329
+ error_code: {
330
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
331
+ enum: ['device_removed'],
751
332
  type: 'string',
752
333
  },
334
+ is_device_error: { enum: [true], type: 'boolean' },
335
+ message: { type: 'string' },
753
336
  },
754
- required: ['message', 'warning_code'],
337
+ required: ['message', 'is_device_error', 'error_code'],
755
338
  type: 'object',
756
339
  },
757
340
  {
758
- description: 'Delay in removing code from device.',
341
+ description: 'Hub is disconnected',
759
342
  properties: {
760
- message: { type: 'string' },
761
- warning_code: {
762
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
763
- enum: ['delay_in_removing_from_device'],
343
+ error_code: {
344
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
345
+ enum: ['hub_disconnected'],
764
346
  type: 'string',
765
347
  },
348
+ is_device_error: { enum: [true], type: 'boolean' },
349
+ message: { type: 'string' },
766
350
  },
767
- required: ['message', 'warning_code'],
351
+ required: ['message', 'is_device_error', 'error_code'],
768
352
  type: 'object',
769
353
  },
770
354
  {
771
- description: 'Third party integration detected that may cause access codes to fail.',
355
+ description: 'Device is disconnected',
772
356
  properties: {
773
- message: { type: 'string' },
774
- warning_code: {
775
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
776
- enum: ['third_party_integration_detected'],
357
+ error_code: {
358
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
359
+ enum: ['device_disconnected'],
777
360
  type: 'string',
778
361
  },
362
+ is_device_error: { enum: [true], type: 'boolean' },
363
+ message: { type: 'string' },
779
364
  },
780
- required: ['message', 'warning_code'],
365
+ required: ['message', 'is_device_error', 'error_code'],
781
366
  type: 'object',
782
367
  },
783
368
  {
784
- description: 'Access code has not yet been fully moved to the device.',
369
+ description: 'The backup access code pool is empty.',
785
370
  properties: {
371
+ error_code: {
372
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
373
+ enum: ['empty_backup_access_code_pool'],
374
+ type: 'string',
375
+ },
376
+ is_device_error: { enum: [true], type: 'boolean' },
786
377
  message: { type: 'string' },
787
- warning_code: {
788
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
789
- enum: ['august_device_programming_delay'],
378
+ },
379
+ required: ['message', 'is_device_error', 'error_code'],
380
+ type: 'object',
381
+ },
382
+ {
383
+ description: 'User is not authorized to use the August Lock.',
384
+ properties: {
385
+ error_code: {
386
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
387
+ enum: ['august_lock_not_authorized'],
790
388
  type: 'string',
791
389
  },
390
+ is_device_error: { enum: [true], type: 'boolean' },
391
+ message: { type: 'string' },
792
392
  },
793
- required: ['message', 'warning_code'],
393
+ required: ['message', 'is_device_error', 'error_code'],
794
394
  type: 'object',
795
395
  },
796
396
  {
797
- description: 'Algopins must be used within 24 hours.',
397
+ description: 'Lock is not connected to the Seam Bridge.',
798
398
  properties: {
399
+ error_code: {
400
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
401
+ enum: ['august_lock_missing_bridge'],
402
+ type: 'string',
403
+ },
404
+ is_device_error: { enum: [true], type: 'boolean' },
799
405
  message: { type: 'string' },
800
- warning_code: {
801
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
802
- enum: ['igloo_algopin_must_be_used_within_24_hours'],
406
+ },
407
+ required: ['message', 'is_device_error', 'error_code'],
408
+ type: 'object',
409
+ },
410
+ {
411
+ description: 'Salto site user limit reached.',
412
+ properties: {
413
+ error_code: {
414
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
415
+ enum: ['salto_site_user_limit_reached'],
803
416
  type: 'string',
804
417
  },
418
+ is_device_error: { enum: [true], type: 'boolean' },
419
+ message: { type: 'string' },
805
420
  },
806
- required: ['message', 'warning_code'],
421
+ required: ['message', 'is_device_error', 'error_code'],
807
422
  type: 'object',
808
423
  },
809
424
  {
810
- description: 'Management was transferred to another workspace.',
425
+ description: 'Lock is not paired with a Gateway.',
811
426
  properties: {
427
+ error_code: {
428
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
429
+ enum: ['ttlock_lock_not_paired_to_gateway'],
430
+ type: 'string',
431
+ },
432
+ is_device_error: { enum: [true], type: 'boolean' },
812
433
  message: { type: 'string' },
813
- warning_code: {
814
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
815
- enum: ['management_transferred'],
434
+ },
435
+ required: ['message', 'is_device_error', 'error_code'],
436
+ type: 'object',
437
+ },
438
+ {
439
+ description: 'Missing device credentials.',
440
+ properties: {
441
+ error_code: {
442
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
443
+ enum: ['missing_device_credentials'],
816
444
  type: 'string',
817
445
  },
446
+ is_device_error: { enum: [true], type: 'boolean' },
447
+ message: { type: 'string' },
818
448
  },
819
- required: ['message', 'warning_code'],
449
+ required: ['message', 'is_device_error', 'error_code'],
450
+ type: 'object',
451
+ },
452
+ {
453
+ description: 'The auxiliary heat is running.',
454
+ properties: {
455
+ error_code: {
456
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
457
+ enum: ['auxiliary_heat_running'],
458
+ type: 'string',
459
+ },
460
+ is_device_error: { enum: [true], type: 'boolean' },
461
+ message: { type: 'string' },
462
+ },
463
+ required: ['message', 'is_device_error', 'error_code'],
464
+ type: 'object',
465
+ },
466
+ {
467
+ description: 'Subscription required to connect.',
468
+ properties: {
469
+ error_code: {
470
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
471
+ enum: ['subscription_required'],
472
+ type: 'string',
473
+ },
474
+ is_device_error: { enum: [true], type: 'boolean' },
475
+ message: { type: 'string' },
476
+ },
477
+ required: ['message', 'is_device_error', 'error_code'],
478
+ type: 'object',
479
+ },
480
+ {
481
+ description: 'Account is disconnected.',
482
+ properties: {
483
+ error_code: {
484
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
485
+ enum: ['account_disconnected'],
486
+ type: 'string',
487
+ },
488
+ is_connected_account_error: {
489
+ enum: [true],
490
+ type: 'boolean',
491
+ },
492
+ message: { type: 'string' },
493
+ },
494
+ required: [
495
+ 'message',
496
+ 'is_connected_account_error',
497
+ 'error_code',
498
+ ],
499
+ type: 'object',
500
+ },
501
+ {
502
+ description: 'Credentials provided were invalid.',
503
+ properties: {
504
+ error_code: {
505
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
506
+ enum: ['invalid_credentials'],
507
+ type: 'string',
508
+ },
509
+ is_connected_account_error: {
510
+ enum: [true],
511
+ type: 'boolean',
512
+ },
513
+ message: { type: 'string' },
514
+ },
515
+ required: [
516
+ 'message',
517
+ 'is_connected_account_error',
518
+ 'error_code',
519
+ ],
820
520
  type: 'object',
821
521
  },
822
522
  ],
823
523
  },
824
524
  type: 'array',
825
525
  },
826
- },
827
- required: [
828
- 'common_code_key',
829
- 'type',
830
- 'access_code_id',
831
- 'device_id',
832
- 'name',
833
- 'code',
834
- 'created_at',
835
- 'errors',
836
- 'warnings',
837
- 'is_managed',
838
- 'status',
839
- 'is_backup_access_code_available',
840
- 'is_external_modification_allowed',
841
- 'is_one_time_use',
842
- 'is_offline_access_code',
843
- ],
844
- type: 'object',
845
- 'x-route-path': '/access_codes',
846
- },
847
- acs_access_group: {
848
- description: 'Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\nThe `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
849
- properties: {
850
- access_group_type: {
851
- deprecated: true,
852
- enum: [
853
- 'pti_unit',
854
- 'pti_access_level',
855
- 'salto_ks_access_group',
856
- 'brivo_group',
857
- 'salto_space_group',
858
- 'dormakaba_community_access_group',
859
- ],
860
- type: 'string',
861
- 'x-deprecated': 'Use `external_type`.',
526
+ is_backup: {
527
+ description: 'Indicates whether the access code is a backup code.',
528
+ type: 'boolean',
862
529
  },
863
- access_group_type_display_name: {
864
- deprecated: true,
865
- type: 'string',
866
- 'x-deprecated': 'Use `external_type_display_name`.',
530
+ is_backup_access_code_available: {
531
+ description: 'Indicates whether a backup access code is available for use if the primary access code is lost or compromised.',
532
+ type: 'boolean',
867
533
  },
868
- acs_access_group_id: {
869
- description: 'ID of the access group.',
870
- format: 'uuid',
534
+ is_external_modification_allowed: {
535
+ description: 'Indicates whether changes to the access code from external sources are permitted.',
536
+ type: 'boolean',
537
+ },
538
+ is_managed: {
539
+ description: 'Indicates whether Seam manages the access code.',
540
+ enum: [true],
541
+ type: 'boolean',
542
+ },
543
+ is_offline_access_code: {
544
+ description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
545
+ type: 'boolean',
546
+ },
547
+ is_one_time_use: {
548
+ description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
549
+ type: 'boolean',
550
+ },
551
+ is_scheduled_on_device: {
552
+ description: 'Indicates whether the code is set on the device according to a preconfigured schedule.',
553
+ type: 'boolean',
554
+ },
555
+ is_waiting_for_code_assignment: {
556
+ description: 'Indicates whether the access code is waiting for a code assignment.',
557
+ type: 'boolean',
558
+ },
559
+ name: {
560
+ description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
561
+ nullable: true,
871
562
  type: 'string',
872
563
  },
873
- acs_system_id: {
874
- description: 'ID of the access control system that contains the access group.',
564
+ pulled_backup_access_code_id: {
565
+ description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.',
875
566
  format: 'uuid',
567
+ nullable: true,
876
568
  type: 'string',
877
569
  },
878
- created_at: {
879
- description: 'Date and time at which the access group was created.',
570
+ starts_at: {
571
+ description: 'Date and time at which the time-bound access code becomes active.',
880
572
  format: 'date-time',
573
+ nullable: true,
881
574
  type: 'string',
882
575
  },
883
- display_name: { type: 'string' },
884
- external_type: {
885
- description: 'Brand-specific terminology for the access group type.',
886
- enum: [
887
- 'pti_unit',
888
- 'pti_access_level',
889
- 'salto_ks_access_group',
890
- 'brivo_group',
891
- 'salto_space_group',
892
- 'dormakaba_community_access_group',
893
- ],
576
+ status: {
577
+ description: '\n Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.\n ',
578
+ enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
894
579
  type: 'string',
895
580
  },
896
- external_type_display_name: {
897
- description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
581
+ type: {
582
+ description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
583
+ enum: ['time_bound', 'ongoing'],
898
584
  type: 'string',
899
585
  },
900
- is_managed: { enum: [true], type: 'boolean' },
901
- name: { description: 'Name of the access group.', type: 'string' },
902
586
  warnings: {
903
- description: 'Warnings associated with the `acs_access_group`.',
587
+ description: '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.',
904
588
  items: {
905
- description: 'Warning associated with the `acs_access_group`.',
906
- properties: {
907
- created_at: {
908
- description: 'Date and time at which Seam created the warning.',
909
- format: 'date-time',
910
- type: 'string',
911
- },
912
- message: {
913
- description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
914
- type: 'string',
589
+ discriminator: { propertyName: 'warning_code' },
590
+ oneOf: [
591
+ {
592
+ description: 'Failed to set code on Smart Things device.',
593
+ properties: {
594
+ message: { type: 'string' },
595
+ warning_code: {
596
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
597
+ enum: ['smartthings_failed_to_set_access_code'],
598
+ type: 'string',
599
+ },
600
+ },
601
+ required: ['message', 'warning_code'],
602
+ type: 'object',
915
603
  },
916
- warning_code: {
917
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
918
- enum: ['unknown_issue_with_acs_access_group'],
604
+ {
605
+ description: 'Duplicate access code detected.',
606
+ properties: {
607
+ message: { type: 'string' },
608
+ warning_code: {
609
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
610
+ enum: ['schlage_detected_duplicate'],
611
+ type: 'string',
612
+ },
613
+ },
614
+ required: ['message', 'warning_code'],
615
+ type: 'object',
616
+ },
617
+ {
618
+ description: 'Received an error when attempting to create this code.',
619
+ properties: {
620
+ message: { type: 'string' },
621
+ warning_code: {
622
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
623
+ enum: ['schlage_creation_outage'],
624
+ type: 'string',
625
+ },
626
+ },
627
+ required: ['message', 'warning_code'],
628
+ type: 'object',
629
+ },
630
+ {
631
+ description: 'Code was modified or removed externally after Seam successfully set it on the device.',
632
+ properties: {
633
+ message: { type: 'string' },
634
+ warning_code: {
635
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
636
+ enum: ['code_modified_external_to_seam'],
637
+ type: 'string',
638
+ },
639
+ },
640
+ required: ['message', 'warning_code'],
641
+ type: 'object',
642
+ },
643
+ {
644
+ description: 'Delay in setting code on device.',
645
+ properties: {
646
+ message: { type: 'string' },
647
+ warning_code: {
648
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
649
+ enum: ['delay_in_setting_on_device'],
650
+ type: 'string',
651
+ },
652
+ },
653
+ required: ['message', 'warning_code'],
654
+ type: 'object',
655
+ },
656
+ {
657
+ description: 'Delay in removing code from device.',
658
+ properties: {
659
+ message: { type: 'string' },
660
+ warning_code: {
661
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
662
+ enum: ['delay_in_removing_from_device'],
663
+ type: 'string',
664
+ },
665
+ },
666
+ required: ['message', 'warning_code'],
667
+ type: 'object',
668
+ },
669
+ {
670
+ description: 'Third party integration detected that may cause access codes to fail.',
671
+ properties: {
672
+ message: { type: 'string' },
673
+ warning_code: {
674
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
675
+ enum: ['third_party_integration_detected'],
676
+ type: 'string',
677
+ },
678
+ },
679
+ required: ['message', 'warning_code'],
680
+ type: 'object',
681
+ },
682
+ {
683
+ description: 'Access code has not yet been fully moved to the device.',
684
+ properties: {
685
+ message: { type: 'string' },
686
+ warning_code: {
687
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
688
+ enum: ['august_device_programming_delay'],
689
+ type: 'string',
690
+ },
691
+ },
692
+ required: ['message', 'warning_code'],
693
+ type: 'object',
694
+ },
695
+ {
696
+ description: 'Algopins must be used within 24 hours.',
697
+ properties: {
698
+ message: { type: 'string' },
699
+ warning_code: {
700
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
701
+ enum: ['igloo_algopin_must_be_used_within_24_hours'],
702
+ type: 'string',
703
+ },
704
+ },
705
+ required: ['message', 'warning_code'],
706
+ type: 'object',
707
+ },
708
+ {
709
+ description: 'Management was transferred to another workspace.',
710
+ properties: {
711
+ message: { type: 'string' },
712
+ warning_code: {
713
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
714
+ enum: ['management_transferred'],
715
+ type: 'string',
716
+ },
717
+ },
718
+ required: ['message', 'warning_code'],
719
+ type: 'object',
720
+ },
721
+ ],
722
+ },
723
+ type: 'array',
724
+ },
725
+ },
726
+ required: [
727
+ 'common_code_key',
728
+ 'type',
729
+ 'access_code_id',
730
+ 'device_id',
731
+ 'name',
732
+ 'code',
733
+ 'created_at',
734
+ 'errors',
735
+ 'warnings',
736
+ 'is_managed',
737
+ 'status',
738
+ 'is_backup_access_code_available',
739
+ 'is_external_modification_allowed',
740
+ 'is_one_time_use',
741
+ 'is_offline_access_code',
742
+ ],
743
+ type: 'object',
744
+ 'x-route-path': '/access_codes',
745
+ },
746
+ acs_access_group: {
747
+ description: 'Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\nThe `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
748
+ properties: {
749
+ access_group_type: {
750
+ deprecated: true,
751
+ enum: [
752
+ 'pti_unit',
753
+ 'pti_access_level',
754
+ 'salto_ks_access_group',
755
+ 'brivo_group',
756
+ 'salto_space_group',
757
+ 'dormakaba_community_access_group',
758
+ ],
759
+ type: 'string',
760
+ 'x-deprecated': 'Use `external_type`.',
761
+ },
762
+ access_group_type_display_name: {
763
+ deprecated: true,
764
+ type: 'string',
765
+ 'x-deprecated': 'Use `external_type_display_name`.',
766
+ },
767
+ acs_access_group_id: {
768
+ description: 'ID of the access group.',
769
+ format: 'uuid',
770
+ type: 'string',
771
+ },
772
+ acs_system_id: {
773
+ description: 'ID of the access control system that contains the access group.',
774
+ format: 'uuid',
775
+ type: 'string',
776
+ },
777
+ created_at: {
778
+ description: 'Date and time at which the access group was created.',
779
+ format: 'date-time',
780
+ type: 'string',
781
+ },
782
+ display_name: { type: 'string' },
783
+ external_type: {
784
+ description: 'Brand-specific terminology for the access group type.',
785
+ enum: [
786
+ 'pti_unit',
787
+ 'pti_access_level',
788
+ 'salto_ks_access_group',
789
+ 'brivo_group',
790
+ 'salto_space_group',
791
+ 'dormakaba_community_access_group',
792
+ ],
793
+ type: 'string',
794
+ },
795
+ external_type_display_name: {
796
+ description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
797
+ type: 'string',
798
+ },
799
+ is_managed: { enum: [true], type: 'boolean' },
800
+ name: { description: 'Name of the access group.', type: 'string' },
801
+ warnings: {
802
+ description: 'Warnings associated with the `acs_access_group`.',
803
+ items: {
804
+ description: 'Warning associated with the `acs_access_group`.',
805
+ properties: {
806
+ created_at: {
807
+ description: 'Date and time at which Seam created the warning.',
808
+ format: 'date-time',
809
+ type: 'string',
810
+ },
811
+ message: {
812
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
813
+ type: 'string',
814
+ },
815
+ warning_code: {
816
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
817
+ enum: ['unknown_issue_with_acs_access_group'],
919
818
  type: 'string',
920
819
  },
921
820
  },
@@ -1093,6 +992,7 @@ export default {
1093
992
  description: 'Warnings associated with the `acs_credential`.',
1094
993
  items: {
1095
994
  description: 'Warning associated with the `acs_credential`.',
995
+ discriminator: { propertyName: 'warning_code' },
1096
996
  oneOf: [
1097
997
  {
1098
998
  description: 'Indicates that the credential is waiting to be issued.',
@@ -1542,6 +1442,7 @@ export default {
1542
1442
  description: 'Errors associated with the `acs_system`.',
1543
1443
  items: {
1544
1444
  description: 'Error associated with the `acs_system`.',
1445
+ discriminator: { propertyName: 'error_code' },
1545
1446
  oneOf: [
1546
1447
  {
1547
1448
  description: 'Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
@@ -1766,6 +1667,7 @@ export default {
1766
1667
  description: 'Warnings associated with the `acs_system`.',
1767
1668
  items: {
1768
1669
  description: 'Warning associated with the `acs_system`.',
1670
+ discriminator: { propertyName: 'warning_code' },
1769
1671
  oneOf: [
1770
1672
  {
1771
1673
  properties: {
@@ -1893,6 +1795,7 @@ export default {
1893
1795
  description: 'Errors associated with the `acs_user`.',
1894
1796
  items: {
1895
1797
  description: 'Error associated with the `acs_user`.',
1798
+ discriminator: { propertyName: 'error_code' },
1896
1799
  oneOf: [
1897
1800
  {
1898
1801
  description: 'Indicates that the ACS user was deleted from the ACS system outside of Seam.',
@@ -2063,6 +1966,7 @@ export default {
2063
1966
  description: 'Warnings associated with the `acs_user`.',
2064
1967
  items: {
2065
1968
  description: 'Warning associated with the `acs_user`.',
1969
+ discriminator: { propertyName: 'warning_code' },
2066
1970
  oneOf: [
2067
1971
  {
2068
1972
  description: 'Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.',
@@ -2554,6 +2458,7 @@ export default {
2554
2458
  description: 'Warnings associated with the `acs_credential`.',
2555
2459
  items: {
2556
2460
  description: 'Warning associated with the `acs_credential`.',
2461
+ discriminator: { propertyName: 'warning_code' },
2557
2462
  oneOf: [
2558
2463
  {
2559
2464
  description: 'Indicates that the credential is waiting to be issued.',
@@ -2890,6 +2795,7 @@ export default {
2890
2795
  description: 'Warnings associated with the `acs_credential`.',
2891
2796
  items: {
2892
2797
  description: 'Warning associated with the `acs_credential`.',
2798
+ discriminator: { propertyName: 'warning_code' },
2893
2799
  oneOf: [
2894
2800
  {
2895
2801
  description: 'Indicates that the credential is waiting to be issued.',
@@ -3358,6 +3264,7 @@ export default {
3358
3264
  description: 'Warnings associated with the `acs_credential`.',
3359
3265
  items: {
3360
3266
  description: 'Warning associated with the `acs_credential`.',
3267
+ discriminator: { propertyName: 'warning_code' },
3361
3268
  oneOf: [
3362
3269
  {
3363
3270
  description: 'Indicates that the credential is waiting to be issued.',
@@ -3692,6 +3599,7 @@ export default {
3692
3599
  description: 'Warnings associated with the `acs_credential`.',
3693
3600
  items: {
3694
3601
  description: 'Warning associated with the `acs_credential`.',
3602
+ discriminator: { propertyName: 'warning_code' },
3695
3603
  oneOf: [
3696
3604
  {
3697
3605
  description: 'Indicates that the credential is waiting to be issued.',
@@ -4926,12 +4834,13 @@ export default {
4926
4834
  },
4927
4835
  errors: {
4928
4836
  items: {
4837
+ discriminator: { propertyName: 'error_code' },
4929
4838
  oneOf: [
4930
4839
  {
4931
4840
  description: 'Account is disconnected.',
4932
4841
  properties: {
4933
4842
  error_code: {
4934
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4843
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4935
4844
  enum: ['account_disconnected'],
4936
4845
  type: 'string',
4937
4846
  },
@@ -4952,7 +4861,7 @@ export default {
4952
4861
  description: 'Credentials provided were invalid.',
4953
4862
  properties: {
4954
4863
  error_code: {
4955
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4864
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4956
4865
  enum: ['invalid_credentials'],
4957
4866
  type: 'string',
4958
4867
  },
@@ -4986,6 +4895,7 @@ export default {
4986
4895
  warnings: {
4987
4896
  items: {
4988
4897
  description: 'Warning associated with the `connected_account`.',
4898
+ discriminator: { propertyName: 'warning_code' },
4989
4899
  oneOf: [
4990
4900
  {
4991
4901
  description: 'Scheduled downtime for account planned.',
@@ -5135,239 +5045,217 @@ export default {
5135
5045
  errors: {
5136
5046
  description: '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.',
5137
5047
  items: {
5048
+ discriminator: { propertyName: 'error_code' },
5138
5049
  oneOf: [
5139
5050
  {
5140
- description: 'Error associated with the `device`.',
5141
- oneOf: [
5142
- {
5143
- description: 'Device is offline',
5144
- properties: {
5145
- error_code: {
5146
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5147
- enum: ['device_offline'],
5148
- type: 'string',
5149
- },
5150
- is_device_error: { enum: [true], type: 'boolean' },
5151
- message: { type: 'string' },
5152
- },
5153
- required: ['message', 'is_device_error', 'error_code'],
5154
- type: 'object',
5051
+ description: 'Device is offline',
5052
+ properties: {
5053
+ error_code: {
5054
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5055
+ enum: ['device_offline'],
5056
+ type: 'string',
5155
5057
  },
5156
- {
5157
- description: 'Device has been removed',
5158
- properties: {
5159
- error_code: {
5160
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5161
- enum: ['device_removed'],
5162
- type: 'string',
5163
- },
5164
- is_device_error: { enum: [true], type: 'boolean' },
5165
- message: { type: 'string' },
5166
- },
5167
- required: ['message', 'is_device_error', 'error_code'],
5168
- type: 'object',
5058
+ is_device_error: { enum: [true], type: 'boolean' },
5059
+ message: { type: 'string' },
5060
+ },
5061
+ required: ['message', 'is_device_error', 'error_code'],
5062
+ type: 'object',
5063
+ },
5064
+ {
5065
+ description: 'Device has been removed',
5066
+ properties: {
5067
+ error_code: {
5068
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5069
+ enum: ['device_removed'],
5070
+ type: 'string',
5169
5071
  },
5170
- {
5171
- description: 'Account is disconnected',
5172
- properties: {
5173
- error_code: {
5174
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5175
- enum: ['account_disconnected'],
5176
- type: 'string',
5177
- },
5178
- is_device_error: { enum: [true], type: 'boolean' },
5179
- message: { type: 'string' },
5180
- },
5181
- required: ['message', 'is_device_error', 'error_code'],
5182
- type: 'object',
5072
+ is_device_error: { enum: [true], type: 'boolean' },
5073
+ message: { type: 'string' },
5074
+ },
5075
+ required: ['message', 'is_device_error', 'error_code'],
5076
+ type: 'object',
5077
+ },
5078
+ {
5079
+ description: 'Hub is disconnected',
5080
+ properties: {
5081
+ error_code: {
5082
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5083
+ enum: ['hub_disconnected'],
5084
+ type: 'string',
5183
5085
  },
5184
- {
5185
- description: 'Hub is disconnected',
5186
- properties: {
5187
- error_code: {
5188
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5189
- enum: ['hub_disconnected'],
5190
- type: 'string',
5191
- },
5192
- is_device_error: { enum: [true], type: 'boolean' },
5193
- message: { type: 'string' },
5194
- },
5195
- required: ['message', 'is_device_error', 'error_code'],
5196
- type: 'object',
5086
+ is_device_error: { enum: [true], type: 'boolean' },
5087
+ message: { type: 'string' },
5088
+ },
5089
+ required: ['message', 'is_device_error', 'error_code'],
5090
+ type: 'object',
5091
+ },
5092
+ {
5093
+ description: 'Device is disconnected',
5094
+ properties: {
5095
+ error_code: {
5096
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5097
+ enum: ['device_disconnected'],
5098
+ type: 'string',
5197
5099
  },
5198
- {
5199
- description: 'Device is disconnected',
5200
- properties: {
5201
- error_code: {
5202
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5203
- enum: ['device_disconnected'],
5204
- type: 'string',
5205
- },
5206
- is_device_error: { enum: [true], type: 'boolean' },
5207
- message: { type: 'string' },
5208
- },
5209
- required: ['message', 'is_device_error', 'error_code'],
5210
- type: 'object',
5100
+ is_device_error: { enum: [true], type: 'boolean' },
5101
+ message: { type: 'string' },
5102
+ },
5103
+ required: ['message', 'is_device_error', 'error_code'],
5104
+ type: 'object',
5105
+ },
5106
+ {
5107
+ description: 'The backup access code pool is empty.',
5108
+ properties: {
5109
+ error_code: {
5110
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5111
+ enum: ['empty_backup_access_code_pool'],
5112
+ type: 'string',
5211
5113
  },
5212
- {
5213
- description: 'The backup access code pool is empty.',
5214
- properties: {
5215
- error_code: {
5216
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5217
- enum: ['empty_backup_access_code_pool'],
5218
- type: 'string',
5219
- },
5220
- is_device_error: { enum: [true], type: 'boolean' },
5221
- message: { type: 'string' },
5222
- },
5223
- required: ['message', 'is_device_error', 'error_code'],
5224
- type: 'object',
5114
+ is_device_error: { enum: [true], type: 'boolean' },
5115
+ message: { type: 'string' },
5116
+ },
5117
+ required: ['message', 'is_device_error', 'error_code'],
5118
+ type: 'object',
5119
+ },
5120
+ {
5121
+ description: 'User is not authorized to use the August Lock.',
5122
+ properties: {
5123
+ error_code: {
5124
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5125
+ enum: ['august_lock_not_authorized'],
5126
+ type: 'string',
5225
5127
  },
5226
- {
5227
- description: 'User is not authorized to use the August Lock.',
5228
- properties: {
5229
- error_code: {
5230
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5231
- enum: ['august_lock_not_authorized'],
5232
- type: 'string',
5233
- },
5234
- is_device_error: { enum: [true], type: 'boolean' },
5235
- message: { type: 'string' },
5236
- },
5237
- required: ['message', 'is_device_error', 'error_code'],
5238
- type: 'object',
5128
+ is_device_error: { enum: [true], type: 'boolean' },
5129
+ message: { type: 'string' },
5130
+ },
5131
+ required: ['message', 'is_device_error', 'error_code'],
5132
+ type: 'object',
5133
+ },
5134
+ {
5135
+ description: 'Lock is not connected to the Seam Bridge.',
5136
+ properties: {
5137
+ error_code: {
5138
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5139
+ enum: ['august_lock_missing_bridge'],
5140
+ type: 'string',
5239
5141
  },
5240
- {
5241
- description: 'Lock is not connected to the Seam Bridge.',
5242
- properties: {
5243
- error_code: {
5244
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5245
- enum: ['august_lock_missing_bridge'],
5246
- type: 'string',
5247
- },
5248
- is_device_error: { enum: [true], type: 'boolean' },
5249
- message: { type: 'string' },
5250
- },
5251
- required: ['message', 'is_device_error', 'error_code'],
5252
- type: 'object',
5142
+ is_device_error: { enum: [true], type: 'boolean' },
5143
+ message: { type: 'string' },
5144
+ },
5145
+ required: ['message', 'is_device_error', 'error_code'],
5146
+ type: 'object',
5147
+ },
5148
+ {
5149
+ description: 'Salto site user limit reached.',
5150
+ properties: {
5151
+ error_code: {
5152
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5153
+ enum: ['salto_site_user_limit_reached'],
5154
+ type: 'string',
5253
5155
  },
5254
- {
5255
- description: 'Salto site user limit reached.',
5256
- properties: {
5257
- error_code: {
5258
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5259
- enum: ['salto_site_user_limit_reached'],
5260
- type: 'string',
5261
- },
5262
- is_device_error: { enum: [true], type: 'boolean' },
5263
- message: { type: 'string' },
5264
- },
5265
- required: ['message', 'is_device_error', 'error_code'],
5266
- type: 'object',
5156
+ is_device_error: { enum: [true], type: 'boolean' },
5157
+ message: { type: 'string' },
5158
+ },
5159
+ required: ['message', 'is_device_error', 'error_code'],
5160
+ type: 'object',
5161
+ },
5162
+ {
5163
+ description: 'Lock is not paired with a Gateway.',
5164
+ properties: {
5165
+ error_code: {
5166
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5167
+ enum: ['ttlock_lock_not_paired_to_gateway'],
5168
+ type: 'string',
5267
5169
  },
5268
- {
5269
- description: 'Lock is not paired with a Gateway.',
5270
- properties: {
5271
- error_code: {
5272
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5273
- enum: ['ttlock_lock_not_paired_to_gateway'],
5274
- type: 'string',
5275
- },
5276
- is_device_error: { enum: [true], type: 'boolean' },
5277
- message: { type: 'string' },
5278
- },
5279
- required: ['message', 'is_device_error', 'error_code'],
5280
- type: 'object',
5170
+ is_device_error: { enum: [true], type: 'boolean' },
5171
+ message: { type: 'string' },
5172
+ },
5173
+ required: ['message', 'is_device_error', 'error_code'],
5174
+ type: 'object',
5175
+ },
5176
+ {
5177
+ description: 'Missing device credentials.',
5178
+ properties: {
5179
+ error_code: {
5180
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5181
+ enum: ['missing_device_credentials'],
5182
+ type: 'string',
5281
5183
  },
5282
- {
5283
- description: 'Missing device credentials.',
5284
- properties: {
5285
- error_code: {
5286
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5287
- enum: ['missing_device_credentials'],
5288
- type: 'string',
5289
- },
5290
- is_device_error: { enum: [true], type: 'boolean' },
5291
- message: { type: 'string' },
5292
- },
5293
- required: ['message', 'is_device_error', 'error_code'],
5294
- type: 'object',
5184
+ is_device_error: { enum: [true], type: 'boolean' },
5185
+ message: { type: 'string' },
5186
+ },
5187
+ required: ['message', 'is_device_error', 'error_code'],
5188
+ type: 'object',
5189
+ },
5190
+ {
5191
+ description: 'The auxiliary heat is running.',
5192
+ properties: {
5193
+ error_code: {
5194
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5195
+ enum: ['auxiliary_heat_running'],
5196
+ type: 'string',
5295
5197
  },
5296
- {
5297
- description: 'The auxiliary heat is running.',
5298
- properties: {
5299
- error_code: {
5300
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5301
- enum: ['auxiliary_heat_running'],
5302
- type: 'string',
5303
- },
5304
- is_device_error: { enum: [true], type: 'boolean' },
5305
- message: { type: 'string' },
5306
- },
5307
- required: ['message', 'is_device_error', 'error_code'],
5308
- type: 'object',
5198
+ is_device_error: { enum: [true], type: 'boolean' },
5199
+ message: { type: 'string' },
5200
+ },
5201
+ required: ['message', 'is_device_error', 'error_code'],
5202
+ type: 'object',
5203
+ },
5204
+ {
5205
+ description: 'Subscription required to connect.',
5206
+ properties: {
5207
+ error_code: {
5208
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5209
+ enum: ['subscription_required'],
5210
+ type: 'string',
5309
5211
  },
5310
- {
5311
- description: 'Subscription required to connect.',
5312
- properties: {
5313
- error_code: {
5314
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5315
- enum: ['subscription_required'],
5316
- type: 'string',
5317
- },
5318
- is_device_error: { enum: [true], type: 'boolean' },
5319
- message: { type: 'string' },
5320
- },
5321
- required: ['message', 'is_device_error', 'error_code'],
5322
- type: 'object',
5212
+ is_device_error: { enum: [true], type: 'boolean' },
5213
+ message: { type: 'string' },
5214
+ },
5215
+ required: ['message', 'is_device_error', 'error_code'],
5216
+ type: 'object',
5217
+ },
5218
+ {
5219
+ description: 'Account is disconnected.',
5220
+ properties: {
5221
+ error_code: {
5222
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5223
+ enum: ['account_disconnected'],
5224
+ type: 'string',
5225
+ },
5226
+ is_connected_account_error: {
5227
+ enum: [true],
5228
+ type: 'boolean',
5323
5229
  },
5230
+ message: { type: 'string' },
5231
+ },
5232
+ required: [
5233
+ 'message',
5234
+ 'is_connected_account_error',
5235
+ 'error_code',
5324
5236
  ],
5237
+ type: 'object',
5325
5238
  },
5326
5239
  {
5327
- oneOf: [
5328
- {
5329
- description: 'Account is disconnected.',
5330
- properties: {
5331
- error_code: {
5332
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5333
- enum: ['account_disconnected'],
5334
- type: 'string',
5335
- },
5336
- is_connected_account_error: {
5337
- enum: [true],
5338
- type: 'boolean',
5339
- },
5340
- message: { type: 'string' },
5341
- },
5342
- required: [
5343
- 'message',
5344
- 'is_connected_account_error',
5345
- 'error_code',
5346
- ],
5347
- type: 'object',
5240
+ description: 'Credentials provided were invalid.',
5241
+ properties: {
5242
+ error_code: {
5243
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5244
+ enum: ['invalid_credentials'],
5245
+ type: 'string',
5348
5246
  },
5349
- {
5350
- description: 'Credentials provided were invalid.',
5351
- properties: {
5352
- error_code: {
5353
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5354
- enum: ['invalid_credentials'],
5355
- type: 'string',
5356
- },
5357
- is_connected_account_error: {
5358
- enum: [true],
5359
- type: 'boolean',
5360
- },
5361
- message: { type: 'string' },
5362
- },
5363
- required: [
5364
- 'message',
5365
- 'is_connected_account_error',
5366
- 'error_code',
5367
- ],
5368
- type: 'object',
5247
+ is_connected_account_error: {
5248
+ enum: [true],
5249
+ type: 'boolean',
5369
5250
  },
5251
+ message: { type: 'string' },
5252
+ },
5253
+ required: [
5254
+ 'message',
5255
+ 'is_connected_account_error',
5256
+ 'error_code',
5370
5257
  ],
5258
+ type: 'object',
5371
5259
  },
5372
5260
  ],
5373
5261
  },
@@ -6601,6 +6489,7 @@ export default {
6601
6489
  warnings: {
6602
6490
  description: '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.',
6603
6491
  items: {
6492
+ discriminator: { propertyName: 'warning_code' },
6604
6493
  oneOf: [
6605
6494
  {
6606
6495
  description: 'Backup access code unhealthy.',
@@ -11088,239 +10977,217 @@ export default {
11088
10977
  errors: {
11089
10978
  description: '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.',
11090
10979
  items: {
10980
+ discriminator: { propertyName: 'error_code' },
11091
10981
  oneOf: [
11092
10982
  {
11093
- description: 'Error associated with the `device`.',
11094
- oneOf: [
11095
- {
11096
- description: 'Device is offline',
11097
- properties: {
11098
- error_code: {
11099
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11100
- enum: ['device_offline'],
11101
- type: 'string',
11102
- },
11103
- is_device_error: { enum: [true], type: 'boolean' },
11104
- message: { type: 'string' },
11105
- },
11106
- required: ['message', 'is_device_error', 'error_code'],
11107
- type: 'object',
11108
- },
11109
- {
11110
- description: 'Device has been removed',
11111
- properties: {
11112
- error_code: {
11113
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11114
- enum: ['device_removed'],
11115
- type: 'string',
11116
- },
11117
- is_device_error: { enum: [true], type: 'boolean' },
11118
- message: { type: 'string' },
11119
- },
11120
- required: ['message', 'is_device_error', 'error_code'],
11121
- type: 'object',
10983
+ description: 'Device is offline',
10984
+ properties: {
10985
+ error_code: {
10986
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10987
+ enum: ['device_offline'],
10988
+ type: 'string',
11122
10989
  },
11123
- {
11124
- description: 'Account is disconnected',
11125
- properties: {
11126
- error_code: {
11127
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11128
- enum: ['account_disconnected'],
11129
- type: 'string',
11130
- },
11131
- is_device_error: { enum: [true], type: 'boolean' },
11132
- message: { type: 'string' },
11133
- },
11134
- required: ['message', 'is_device_error', 'error_code'],
11135
- type: 'object',
10990
+ is_device_error: { enum: [true], type: 'boolean' },
10991
+ message: { type: 'string' },
10992
+ },
10993
+ required: ['message', 'is_device_error', 'error_code'],
10994
+ type: 'object',
10995
+ },
10996
+ {
10997
+ description: 'Device has been removed',
10998
+ properties: {
10999
+ error_code: {
11000
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11001
+ enum: ['device_removed'],
11002
+ type: 'string',
11136
11003
  },
11137
- {
11138
- description: 'Hub is disconnected',
11139
- properties: {
11140
- error_code: {
11141
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11142
- enum: ['hub_disconnected'],
11143
- type: 'string',
11144
- },
11145
- is_device_error: { enum: [true], type: 'boolean' },
11146
- message: { type: 'string' },
11147
- },
11148
- required: ['message', 'is_device_error', 'error_code'],
11149
- type: 'object',
11004
+ is_device_error: { enum: [true], type: 'boolean' },
11005
+ message: { type: 'string' },
11006
+ },
11007
+ required: ['message', 'is_device_error', 'error_code'],
11008
+ type: 'object',
11009
+ },
11010
+ {
11011
+ description: 'Hub is disconnected',
11012
+ properties: {
11013
+ error_code: {
11014
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11015
+ enum: ['hub_disconnected'],
11016
+ type: 'string',
11150
11017
  },
11151
- {
11152
- description: 'Device is disconnected',
11153
- properties: {
11154
- error_code: {
11155
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11156
- enum: ['device_disconnected'],
11157
- type: 'string',
11158
- },
11159
- is_device_error: { enum: [true], type: 'boolean' },
11160
- message: { type: 'string' },
11161
- },
11162
- required: ['message', 'is_device_error', 'error_code'],
11163
- type: 'object',
11018
+ is_device_error: { enum: [true], type: 'boolean' },
11019
+ message: { type: 'string' },
11020
+ },
11021
+ required: ['message', 'is_device_error', 'error_code'],
11022
+ type: 'object',
11023
+ },
11024
+ {
11025
+ description: 'Device is disconnected',
11026
+ properties: {
11027
+ error_code: {
11028
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11029
+ enum: ['device_disconnected'],
11030
+ type: 'string',
11164
11031
  },
11165
- {
11166
- description: 'The backup access code pool is empty.',
11167
- properties: {
11168
- error_code: {
11169
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11170
- enum: ['empty_backup_access_code_pool'],
11171
- type: 'string',
11172
- },
11173
- is_device_error: { enum: [true], type: 'boolean' },
11174
- message: { type: 'string' },
11175
- },
11176
- required: ['message', 'is_device_error', 'error_code'],
11177
- type: 'object',
11032
+ is_device_error: { enum: [true], type: 'boolean' },
11033
+ message: { type: 'string' },
11034
+ },
11035
+ required: ['message', 'is_device_error', 'error_code'],
11036
+ type: 'object',
11037
+ },
11038
+ {
11039
+ description: 'The backup access code pool is empty.',
11040
+ properties: {
11041
+ error_code: {
11042
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11043
+ enum: ['empty_backup_access_code_pool'],
11044
+ type: 'string',
11178
11045
  },
11179
- {
11180
- description: 'User is not authorized to use the August Lock.',
11181
- properties: {
11182
- error_code: {
11183
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11184
- enum: ['august_lock_not_authorized'],
11185
- type: 'string',
11186
- },
11187
- is_device_error: { enum: [true], type: 'boolean' },
11188
- message: { type: 'string' },
11189
- },
11190
- required: ['message', 'is_device_error', 'error_code'],
11191
- type: 'object',
11046
+ is_device_error: { enum: [true], type: 'boolean' },
11047
+ message: { type: 'string' },
11048
+ },
11049
+ required: ['message', 'is_device_error', 'error_code'],
11050
+ type: 'object',
11051
+ },
11052
+ {
11053
+ description: 'User is not authorized to use the August Lock.',
11054
+ properties: {
11055
+ error_code: {
11056
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11057
+ enum: ['august_lock_not_authorized'],
11058
+ type: 'string',
11192
11059
  },
11193
- {
11194
- description: 'Lock is not connected to the Seam Bridge.',
11195
- properties: {
11196
- error_code: {
11197
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11198
- enum: ['august_lock_missing_bridge'],
11199
- type: 'string',
11200
- },
11201
- is_device_error: { enum: [true], type: 'boolean' },
11202
- message: { type: 'string' },
11203
- },
11204
- required: ['message', 'is_device_error', 'error_code'],
11205
- type: 'object',
11060
+ is_device_error: { enum: [true], type: 'boolean' },
11061
+ message: { type: 'string' },
11062
+ },
11063
+ required: ['message', 'is_device_error', 'error_code'],
11064
+ type: 'object',
11065
+ },
11066
+ {
11067
+ description: 'Lock is not connected to the Seam Bridge.',
11068
+ properties: {
11069
+ error_code: {
11070
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11071
+ enum: ['august_lock_missing_bridge'],
11072
+ type: 'string',
11206
11073
  },
11207
- {
11208
- description: 'Salto site user limit reached.',
11209
- properties: {
11210
- error_code: {
11211
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11212
- enum: ['salto_site_user_limit_reached'],
11213
- type: 'string',
11214
- },
11215
- is_device_error: { enum: [true], type: 'boolean' },
11216
- message: { type: 'string' },
11217
- },
11218
- required: ['message', 'is_device_error', 'error_code'],
11219
- type: 'object',
11074
+ is_device_error: { enum: [true], type: 'boolean' },
11075
+ message: { type: 'string' },
11076
+ },
11077
+ required: ['message', 'is_device_error', 'error_code'],
11078
+ type: 'object',
11079
+ },
11080
+ {
11081
+ description: 'Salto site user limit reached.',
11082
+ properties: {
11083
+ error_code: {
11084
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11085
+ enum: ['salto_site_user_limit_reached'],
11086
+ type: 'string',
11220
11087
  },
11221
- {
11222
- description: 'Lock is not paired with a Gateway.',
11223
- properties: {
11224
- error_code: {
11225
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11226
- enum: ['ttlock_lock_not_paired_to_gateway'],
11227
- type: 'string',
11228
- },
11229
- is_device_error: { enum: [true], type: 'boolean' },
11230
- message: { type: 'string' },
11231
- },
11232
- required: ['message', 'is_device_error', 'error_code'],
11233
- type: 'object',
11088
+ is_device_error: { enum: [true], type: 'boolean' },
11089
+ message: { type: 'string' },
11090
+ },
11091
+ required: ['message', 'is_device_error', 'error_code'],
11092
+ type: 'object',
11093
+ },
11094
+ {
11095
+ description: 'Lock is not paired with a Gateway.',
11096
+ properties: {
11097
+ error_code: {
11098
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11099
+ enum: ['ttlock_lock_not_paired_to_gateway'],
11100
+ type: 'string',
11234
11101
  },
11235
- {
11236
- description: 'Missing device credentials.',
11237
- properties: {
11238
- error_code: {
11239
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11240
- enum: ['missing_device_credentials'],
11241
- type: 'string',
11242
- },
11243
- is_device_error: { enum: [true], type: 'boolean' },
11244
- message: { type: 'string' },
11245
- },
11246
- required: ['message', 'is_device_error', 'error_code'],
11247
- type: 'object',
11102
+ is_device_error: { enum: [true], type: 'boolean' },
11103
+ message: { type: 'string' },
11104
+ },
11105
+ required: ['message', 'is_device_error', 'error_code'],
11106
+ type: 'object',
11107
+ },
11108
+ {
11109
+ description: 'Missing device credentials.',
11110
+ properties: {
11111
+ error_code: {
11112
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11113
+ enum: ['missing_device_credentials'],
11114
+ type: 'string',
11248
11115
  },
11249
- {
11250
- description: 'The auxiliary heat is running.',
11251
- properties: {
11252
- error_code: {
11253
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11254
- enum: ['auxiliary_heat_running'],
11255
- type: 'string',
11256
- },
11257
- is_device_error: { enum: [true], type: 'boolean' },
11258
- message: { type: 'string' },
11259
- },
11260
- required: ['message', 'is_device_error', 'error_code'],
11261
- type: 'object',
11116
+ is_device_error: { enum: [true], type: 'boolean' },
11117
+ message: { type: 'string' },
11118
+ },
11119
+ required: ['message', 'is_device_error', 'error_code'],
11120
+ type: 'object',
11121
+ },
11122
+ {
11123
+ description: 'The auxiliary heat is running.',
11124
+ properties: {
11125
+ error_code: {
11126
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11127
+ enum: ['auxiliary_heat_running'],
11128
+ type: 'string',
11262
11129
  },
11263
- {
11264
- description: 'Subscription required to connect.',
11265
- properties: {
11266
- error_code: {
11267
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11268
- enum: ['subscription_required'],
11269
- type: 'string',
11270
- },
11271
- is_device_error: { enum: [true], type: 'boolean' },
11272
- message: { type: 'string' },
11273
- },
11274
- required: ['message', 'is_device_error', 'error_code'],
11275
- type: 'object',
11130
+ is_device_error: { enum: [true], type: 'boolean' },
11131
+ message: { type: 'string' },
11132
+ },
11133
+ required: ['message', 'is_device_error', 'error_code'],
11134
+ type: 'object',
11135
+ },
11136
+ {
11137
+ description: 'Subscription required to connect.',
11138
+ properties: {
11139
+ error_code: {
11140
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11141
+ enum: ['subscription_required'],
11142
+ type: 'string',
11143
+ },
11144
+ is_device_error: { enum: [true], type: 'boolean' },
11145
+ message: { type: 'string' },
11146
+ },
11147
+ required: ['message', 'is_device_error', 'error_code'],
11148
+ type: 'object',
11149
+ },
11150
+ {
11151
+ description: 'Account is disconnected.',
11152
+ properties: {
11153
+ error_code: {
11154
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11155
+ enum: ['account_disconnected'],
11156
+ type: 'string',
11157
+ },
11158
+ is_connected_account_error: {
11159
+ enum: [true],
11160
+ type: 'boolean',
11276
11161
  },
11162
+ message: { type: 'string' },
11163
+ },
11164
+ required: [
11165
+ 'message',
11166
+ 'is_connected_account_error',
11167
+ 'error_code',
11277
11168
  ],
11169
+ type: 'object',
11278
11170
  },
11279
11171
  {
11280
- oneOf: [
11281
- {
11282
- description: 'Account is disconnected.',
11283
- properties: {
11284
- error_code: {
11285
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11286
- enum: ['account_disconnected'],
11287
- type: 'string',
11288
- },
11289
- is_connected_account_error: {
11290
- enum: [true],
11291
- type: 'boolean',
11292
- },
11293
- message: { type: 'string' },
11294
- },
11295
- required: [
11296
- 'message',
11297
- 'is_connected_account_error',
11298
- 'error_code',
11299
- ],
11300
- type: 'object',
11172
+ description: 'Credentials provided were invalid.',
11173
+ properties: {
11174
+ error_code: {
11175
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11176
+ enum: ['invalid_credentials'],
11177
+ type: 'string',
11301
11178
  },
11302
- {
11303
- description: 'Credentials provided were invalid.',
11304
- properties: {
11305
- error_code: {
11306
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11307
- enum: ['invalid_credentials'],
11308
- type: 'string',
11309
- },
11310
- is_connected_account_error: {
11311
- enum: [true],
11312
- type: 'boolean',
11313
- },
11314
- message: { type: 'string' },
11315
- },
11316
- required: [
11317
- 'message',
11318
- 'is_connected_account_error',
11319
- 'error_code',
11320
- ],
11321
- type: 'object',
11179
+ is_connected_account_error: {
11180
+ enum: [true],
11181
+ type: 'boolean',
11322
11182
  },
11183
+ message: { type: 'string' },
11184
+ },
11185
+ required: [
11186
+ 'message',
11187
+ 'is_connected_account_error',
11188
+ 'error_code',
11323
11189
  ],
11190
+ type: 'object',
11324
11191
  },
11325
11192
  ],
11326
11193
  },
@@ -11381,6 +11248,7 @@ export default {
11381
11248
  warnings: {
11382
11249
  description: '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.',
11383
11250
  items: {
11251
+ discriminator: { propertyName: 'warning_code' },
11384
11252
  oneOf: [
11385
11253
  {
11386
11254
  description: 'Backup access code unhealthy.',
@@ -11730,589 +11598,487 @@ export default {
11730
11598
  errors: {
11731
11599
  description: '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.',
11732
11600
  items: {
11601
+ discriminator: { propertyName: 'error_code' },
11733
11602
  oneOf: [
11734
11603
  {
11735
- oneOf: [
11736
- {
11737
- description: 'Failed to set code on Smart Things device.',
11738
- properties: {
11739
- error_code: {
11740
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11741
- enum: ['smartthings_failed_to_set_access_code'],
11742
- type: 'string',
11743
- },
11744
- is_access_code_error: { enum: [true], type: 'boolean' },
11745
- message: { type: 'string' },
11746
- },
11747
- required: [
11748
- 'message',
11749
- 'is_access_code_error',
11750
- 'error_code',
11751
- ],
11752
- type: 'object',
11604
+ description: 'Failed to set code on Smart Things device.',
11605
+ properties: {
11606
+ error_code: {
11607
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11608
+ enum: ['smartthings_failed_to_set_access_code'],
11609
+ type: 'string',
11753
11610
  },
11754
- {
11755
- description: 'Failed to set code after multiple retries.',
11756
- properties: {
11757
- error_code: {
11758
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11759
- enum: [
11760
- 'smartthings_failed_to_set_after_multiple_retries',
11761
- ],
11762
- type: 'string',
11763
- },
11764
- is_access_code_error: { enum: [true], type: 'boolean' },
11765
- message: { type: 'string' },
11766
- },
11767
- required: [
11768
- 'message',
11769
- 'is_access_code_error',
11770
- 'error_code',
11611
+ is_access_code_error: { enum: [true], type: 'boolean' },
11612
+ message: { type: 'string' },
11613
+ },
11614
+ required: ['message', 'is_access_code_error', 'error_code'],
11615
+ type: 'object',
11616
+ },
11617
+ {
11618
+ description: 'Failed to set code after multiple retries.',
11619
+ properties: {
11620
+ error_code: {
11621
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11622
+ enum: [
11623
+ 'smartthings_failed_to_set_after_multiple_retries',
11771
11624
  ],
11772
- type: 'object',
11625
+ type: 'string',
11773
11626
  },
11774
- {
11775
- description: 'Failed to set code on device.',
11776
- properties: {
11777
- error_code: {
11778
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11779
- enum: ['failed_to_set_on_device'],
11780
- type: 'string',
11781
- },
11782
- is_access_code_error: { enum: [true], type: 'boolean' },
11783
- message: { type: 'string' },
11784
- },
11785
- required: [
11786
- 'message',
11787
- 'is_access_code_error',
11788
- 'error_code',
11789
- ],
11790
- type: 'object',
11627
+ is_access_code_error: { enum: [true], type: 'boolean' },
11628
+ message: { type: 'string' },
11629
+ },
11630
+ required: ['message', 'is_access_code_error', 'error_code'],
11631
+ type: 'object',
11632
+ },
11633
+ {
11634
+ description: 'Failed to set code on device.',
11635
+ properties: {
11636
+ error_code: {
11637
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11638
+ enum: ['failed_to_set_on_device'],
11639
+ type: 'string',
11791
11640
  },
11792
- {
11793
- description: 'Failed to remove code from device.',
11794
- properties: {
11795
- error_code: {
11796
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11797
- enum: ['failed_to_remove_from_device'],
11798
- type: 'string',
11799
- },
11800
- is_access_code_error: { enum: [true], type: 'boolean' },
11801
- message: { type: 'string' },
11802
- },
11803
- required: [
11804
- 'message',
11805
- 'is_access_code_error',
11806
- 'error_code',
11807
- ],
11808
- type: 'object',
11641
+ is_access_code_error: { enum: [true], type: 'boolean' },
11642
+ message: { type: 'string' },
11643
+ },
11644
+ required: ['message', 'is_access_code_error', 'error_code'],
11645
+ type: 'object',
11646
+ },
11647
+ {
11648
+ description: 'Failed to remove code from device.',
11649
+ properties: {
11650
+ error_code: {
11651
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11652
+ enum: ['failed_to_remove_from_device'],
11653
+ type: 'string',
11809
11654
  },
11810
- {
11811
- description: 'Duplicate access code detected on device.',
11812
- properties: {
11813
- error_code: {
11814
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11815
- enum: ['duplicate_code_on_device'],
11816
- type: 'string',
11817
- },
11818
- is_access_code_error: { enum: [true], type: 'boolean' },
11819
- message: { type: 'string' },
11820
- },
11821
- required: [
11822
- 'message',
11823
- 'is_access_code_error',
11824
- 'error_code',
11825
- ],
11826
- type: 'object',
11655
+ is_access_code_error: { enum: [true], type: 'boolean' },
11656
+ message: { type: 'string' },
11657
+ },
11658
+ required: ['message', 'is_access_code_error', 'error_code'],
11659
+ type: 'object',
11660
+ },
11661
+ {
11662
+ description: 'Duplicate access code detected on device.',
11663
+ properties: {
11664
+ error_code: {
11665
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11666
+ enum: ['duplicate_code_on_device'],
11667
+ type: 'string',
11827
11668
  },
11828
- {
11829
- description: 'An attempt to modify this access code was prevented.',
11830
- properties: {
11831
- error_code: {
11832
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11833
- enum: ['duplicate_code_attempt_prevented'],
11834
- type: 'string',
11835
- },
11836
- is_access_code_error: { enum: [true], type: 'boolean' },
11837
- message: { type: 'string' },
11838
- },
11839
- required: [
11840
- 'message',
11841
- 'is_access_code_error',
11842
- 'error_code',
11843
- ],
11844
- type: 'object',
11669
+ is_access_code_error: { enum: [true], type: 'boolean' },
11670
+ message: { type: 'string' },
11671
+ },
11672
+ required: ['message', 'is_access_code_error', 'error_code'],
11673
+ type: 'object',
11674
+ },
11675
+ {
11676
+ description: 'An attempt to modify this access code was prevented.',
11677
+ properties: {
11678
+ error_code: {
11679
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11680
+ enum: ['duplicate_code_attempt_prevented'],
11681
+ type: 'string',
11845
11682
  },
11846
- {
11847
- description: 'Igloohome bridge has too many pending jobs in the queue.',
11848
- properties: {
11849
- error_code: {
11850
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11851
- enum: ['igloohome_bridge_too_many_pending_jobs'],
11852
- type: 'string',
11853
- },
11854
- is_access_code_error: { enum: [true], type: 'boolean' },
11855
- message: { type: 'string' },
11856
- },
11857
- required: [
11858
- 'message',
11859
- 'is_access_code_error',
11860
- 'error_code',
11861
- ],
11862
- type: 'object',
11683
+ is_access_code_error: { enum: [true], type: 'boolean' },
11684
+ message: { type: 'string' },
11685
+ },
11686
+ required: ['message', 'is_access_code_error', 'error_code'],
11687
+ type: 'object',
11688
+ },
11689
+ {
11690
+ description: 'Igloohome bridge has too many pending jobs in the queue.',
11691
+ properties: {
11692
+ error_code: {
11693
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11694
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
11695
+ type: 'string',
11863
11696
  },
11864
- {
11865
- description: 'Igloohome bridge is offline.',
11866
- properties: {
11867
- error_code: {
11868
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11869
- enum: ['igloohome_bridge_offline'],
11870
- type: 'string',
11871
- },
11872
- is_access_code_error: { enum: [true], type: 'boolean' },
11873
- message: { type: 'string' },
11874
- },
11875
- required: [
11876
- 'message',
11877
- 'is_access_code_error',
11878
- 'error_code',
11879
- ],
11880
- type: 'object',
11697
+ is_access_code_error: { enum: [true], type: 'boolean' },
11698
+ message: { type: 'string' },
11699
+ },
11700
+ required: ['message', 'is_access_code_error', 'error_code'],
11701
+ type: 'object',
11702
+ },
11703
+ {
11704
+ description: 'Igloohome bridge is offline.',
11705
+ properties: {
11706
+ error_code: {
11707
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11708
+ enum: ['igloohome_bridge_offline'],
11709
+ type: 'string',
11881
11710
  },
11882
- {
11883
- description: 'Lock as reached max amount of codes.',
11884
- properties: {
11885
- error_code: {
11886
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11887
- enum: [
11888
- 'igloohome_offline_access_code_no_variance_available',
11889
- ],
11890
- type: 'string',
11891
- },
11892
- is_access_code_error: { enum: [true], type: 'boolean' },
11893
- message: { type: 'string' },
11894
- },
11895
- required: [
11896
- 'message',
11897
- 'is_access_code_error',
11898
- 'error_code',
11711
+ is_access_code_error: { enum: [true], type: 'boolean' },
11712
+ message: { type: 'string' },
11713
+ },
11714
+ required: ['message', 'is_access_code_error', 'error_code'],
11715
+ type: 'object',
11716
+ },
11717
+ {
11718
+ description: 'Lock as reached max amount of codes.',
11719
+ properties: {
11720
+ error_code: {
11721
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11722
+ enum: [
11723
+ 'igloohome_offline_access_code_no_variance_available',
11899
11724
  ],
11900
- type: 'object',
11725
+ type: 'string',
11901
11726
  },
11902
- {
11903
- description: 'Unable to confirm the access code is set on Kwikset device.',
11904
- properties: {
11905
- error_code: {
11906
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11907
- enum: ['kwikset_unable_to_confirm_code'],
11908
- type: 'string',
11909
- },
11910
- is_access_code_error: { enum: [true], type: 'boolean' },
11911
- message: { type: 'string' },
11912
- },
11913
- required: [
11914
- 'message',
11915
- 'is_access_code_error',
11916
- 'error_code',
11917
- ],
11918
- type: 'object',
11727
+ is_access_code_error: { enum: [true], type: 'boolean' },
11728
+ message: { type: 'string' },
11729
+ },
11730
+ required: ['message', 'is_access_code_error', 'error_code'],
11731
+ type: 'object',
11732
+ },
11733
+ {
11734
+ description: 'Unable to confirm the access code is set on Kwikset device.',
11735
+ properties: {
11736
+ error_code: {
11737
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11738
+ enum: ['kwikset_unable_to_confirm_code'],
11739
+ type: 'string',
11919
11740
  },
11920
- {
11921
- description: 'Unable to confirm the deletion of the access code on Kwikset device.',
11922
- properties: {
11923
- error_code: {
11924
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11925
- enum: ['kwikset_unable_to_confirm_deletion'],
11926
- type: 'string',
11927
- },
11928
- is_access_code_error: { enum: [true], type: 'boolean' },
11929
- message: { type: 'string' },
11930
- },
11931
- required: [
11932
- 'message',
11933
- 'is_access_code_error',
11934
- 'error_code',
11935
- ],
11936
- type: 'object',
11741
+ is_access_code_error: { enum: [true], type: 'boolean' },
11742
+ message: { type: 'string' },
11743
+ },
11744
+ required: ['message', 'is_access_code_error', 'error_code'],
11745
+ type: 'object',
11746
+ },
11747
+ {
11748
+ description: 'Unable to confirm the deletion of the access code on Kwikset device.',
11749
+ properties: {
11750
+ error_code: {
11751
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11752
+ enum: ['kwikset_unable_to_confirm_deletion'],
11753
+ type: 'string',
11937
11754
  },
11938
- {
11939
- description: 'Code was modified or removed externally after Seam successfully set it on the device.',
11940
- properties: {
11941
- error_code: {
11942
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11943
- enum: ['code_modified_external_to_seam'],
11944
- type: 'string',
11945
- },
11946
- is_access_code_error: { enum: [true], type: 'boolean' },
11947
- message: { type: 'string' },
11948
- },
11949
- required: [
11950
- 'message',
11951
- 'is_access_code_error',
11952
- 'error_code',
11953
- ],
11954
- type: 'object',
11755
+ is_access_code_error: { enum: [true], type: 'boolean' },
11756
+ message: { type: 'string' },
11757
+ },
11758
+ required: ['message', 'is_access_code_error', 'error_code'],
11759
+ type: 'object',
11760
+ },
11761
+ {
11762
+ description: 'Code was modified or removed externally after Seam successfully set it on the device.',
11763
+ properties: {
11764
+ error_code: {
11765
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11766
+ enum: ['code_modified_external_to_seam'],
11767
+ type: 'string',
11955
11768
  },
11956
- {
11957
- description: 'Invalid code length for August lock.',
11958
- properties: {
11959
- error_code: {
11960
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11961
- enum: ['august_lock_invalid_code_length'],
11962
- type: 'string',
11963
- },
11964
- is_access_code_error: { enum: [true], type: 'boolean' },
11965
- message: { type: 'string' },
11966
- },
11967
- required: [
11968
- 'message',
11969
- 'is_access_code_error',
11970
- 'error_code',
11971
- ],
11972
- type: 'object',
11769
+ is_access_code_error: { enum: [true], type: 'boolean' },
11770
+ message: { type: 'string' },
11771
+ },
11772
+ required: ['message', 'is_access_code_error', 'error_code'],
11773
+ type: 'object',
11774
+ },
11775
+ {
11776
+ description: 'Invalid code length for August lock.',
11777
+ properties: {
11778
+ error_code: {
11779
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11780
+ enum: ['august_lock_invalid_code_length'],
11781
+ type: 'string',
11973
11782
  },
11974
- {
11975
- description: 'Access code has not yet been fully moved to the device.',
11976
- properties: {
11977
- error_code: {
11978
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11979
- enum: ['august_device_programming_delay'],
11980
- type: 'string',
11981
- },
11982
- is_access_code_error: { enum: [true], type: 'boolean' },
11983
- message: { type: 'string' },
11984
- },
11985
- required: [
11986
- 'message',
11987
- 'is_access_code_error',
11988
- 'error_code',
11989
- ],
11990
- type: 'object',
11783
+ is_access_code_error: { enum: [true], type: 'boolean' },
11784
+ message: { type: 'string' },
11785
+ },
11786
+ required: ['message', 'is_access_code_error', 'error_code'],
11787
+ type: 'object',
11788
+ },
11789
+ {
11790
+ description: 'Access code has not yet been fully moved to the device.',
11791
+ properties: {
11792
+ error_code: {
11793
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11794
+ enum: ['august_device_programming_delay'],
11795
+ type: 'string',
11991
11796
  },
11992
- {
11993
- description: 'All access code slots on the device are full.',
11994
- properties: {
11995
- error_code: {
11996
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11997
- enum: ['august_device_slots_full'],
11998
- type: 'string',
11999
- },
12000
- is_access_code_error: { enum: [true], type: 'boolean' },
12001
- message: { type: 'string' },
12002
- },
12003
- required: [
12004
- 'message',
12005
- 'is_access_code_error',
12006
- 'error_code',
12007
- ],
12008
- type: 'object',
11797
+ is_access_code_error: { enum: [true], type: 'boolean' },
11798
+ message: { type: 'string' },
11799
+ },
11800
+ required: ['message', 'is_access_code_error', 'error_code'],
11801
+ type: 'object',
11802
+ },
11803
+ {
11804
+ description: 'All access code slots on the device are full.',
11805
+ properties: {
11806
+ error_code: {
11807
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11808
+ enum: ['august_device_slots_full'],
11809
+ type: 'string',
12009
11810
  },
12010
- {
12011
- description: 'August lock is missing a keypad.',
12012
- properties: {
12013
- error_code: {
12014
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12015
- enum: ['august_lock_missing_keypad'],
12016
- type: 'string',
12017
- },
12018
- is_access_code_error: { enum: [true], type: 'boolean' },
12019
- message: { type: 'string' },
12020
- },
12021
- required: [
12022
- 'message',
12023
- 'is_access_code_error',
12024
- 'error_code',
12025
- ],
12026
- type: 'object',
11811
+ is_access_code_error: { enum: [true], type: 'boolean' },
11812
+ message: { type: 'string' },
11813
+ },
11814
+ required: ['message', 'is_access_code_error', 'error_code'],
11815
+ type: 'object',
11816
+ },
11817
+ {
11818
+ description: 'August lock is missing a keypad.',
11819
+ properties: {
11820
+ error_code: {
11821
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11822
+ enum: ['august_lock_missing_keypad'],
11823
+ type: 'string',
12027
11824
  },
12028
- {
12029
- description: 'Salto site user is not subscribed.',
12030
- properties: {
12031
- error_code: {
12032
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12033
- enum: ['salto_site_user_not_subscribed'],
12034
- type: 'string',
12035
- },
12036
- is_access_code_error: { enum: [true], type: 'boolean' },
12037
- message: { type: 'string' },
12038
- },
12039
- required: [
12040
- 'message',
12041
- 'is_access_code_error',
12042
- 'error_code',
12043
- ],
12044
- type: 'object',
11825
+ is_access_code_error: { enum: [true], type: 'boolean' },
11826
+ message: { type: 'string' },
11827
+ },
11828
+ required: ['message', 'is_access_code_error', 'error_code'],
11829
+ type: 'object',
11830
+ },
11831
+ {
11832
+ description: 'Salto site user is not subscribed.',
11833
+ properties: {
11834
+ error_code: {
11835
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11836
+ enum: ['salto_site_user_not_subscribed'],
11837
+ type: 'string',
11838
+ },
11839
+ is_access_code_error: { enum: [true], type: 'boolean' },
11840
+ message: { type: 'string' },
11841
+ },
11842
+ required: ['message', 'is_access_code_error', 'error_code'],
11843
+ type: 'object',
11844
+ },
11845
+ {
11846
+ description: 'Access code has not yet been fully moved to the device.',
11847
+ properties: {
11848
+ error_code: {
11849
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11850
+ enum: ['hubitat_device_programming_delay'],
11851
+ type: 'string',
12045
11852
  },
12046
- {
12047
- description: 'Access code has not yet been fully moved to the device.',
12048
- properties: {
12049
- error_code: {
12050
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12051
- enum: ['hubitat_device_programming_delay'],
12052
- type: 'string',
12053
- },
12054
- is_access_code_error: { enum: [true], type: 'boolean' },
12055
- message: { type: 'string' },
12056
- },
12057
- required: [
12058
- 'message',
12059
- 'is_access_code_error',
12060
- 'error_code',
12061
- ],
12062
- type: 'object',
11853
+ is_access_code_error: { enum: [true], type: 'boolean' },
11854
+ message: { type: 'string' },
11855
+ },
11856
+ required: ['message', 'is_access_code_error', 'error_code'],
11857
+ type: 'object',
11858
+ },
11859
+ {
11860
+ description: 'No free positions available on the device.',
11861
+ properties: {
11862
+ error_code: {
11863
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11864
+ enum: ['hubitat_no_free_positions_available'],
11865
+ type: 'string',
12063
11866
  },
12064
- {
12065
- description: 'No free positions available on the device.',
12066
- properties: {
12067
- error_code: {
12068
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12069
- enum: ['hubitat_no_free_positions_available'],
12070
- type: 'string',
12071
- },
12072
- is_access_code_error: { enum: [true], type: 'boolean' },
12073
- message: { type: 'string' },
12074
- },
12075
- required: [
12076
- 'message',
12077
- 'is_access_code_error',
12078
- 'error_code',
12079
- ],
12080
- type: 'object',
11867
+ is_access_code_error: { enum: [true], type: 'boolean' },
11868
+ message: { type: 'string' },
11869
+ },
11870
+ required: ['message', 'is_access_code_error', 'error_code'],
11871
+ type: 'object',
11872
+ },
11873
+ {
11874
+ description: 'Device is offline',
11875
+ properties: {
11876
+ error_code: {
11877
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11878
+ enum: ['device_offline'],
11879
+ type: 'string',
12081
11880
  },
12082
- ],
11881
+ is_device_error: { enum: [true], type: 'boolean' },
11882
+ message: { type: 'string' },
11883
+ },
11884
+ required: ['message', 'is_device_error', 'error_code'],
11885
+ type: 'object',
12083
11886
  },
12084
11887
  {
12085
- description: 'Error associated with the `device`.',
12086
- oneOf: [
12087
- {
12088
- description: 'Device is offline',
12089
- properties: {
12090
- error_code: {
12091
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12092
- enum: ['device_offline'],
12093
- type: 'string',
12094
- },
12095
- is_device_error: { enum: [true], type: 'boolean' },
12096
- message: { type: 'string' },
12097
- },
12098
- required: ['message', 'is_device_error', 'error_code'],
12099
- type: 'object',
11888
+ description: 'Device has been removed',
11889
+ properties: {
11890
+ error_code: {
11891
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11892
+ enum: ['device_removed'],
11893
+ type: 'string',
12100
11894
  },
12101
- {
12102
- description: 'Device has been removed',
12103
- properties: {
12104
- error_code: {
12105
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12106
- enum: ['device_removed'],
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',
11895
+ is_device_error: { enum: [true], type: 'boolean' },
11896
+ message: { type: 'string' },
11897
+ },
11898
+ required: ['message', 'is_device_error', 'error_code'],
11899
+ type: 'object',
11900
+ },
11901
+ {
11902
+ description: 'Hub is disconnected',
11903
+ properties: {
11904
+ error_code: {
11905
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11906
+ enum: ['hub_disconnected'],
11907
+ type: 'string',
12114
11908
  },
12115
- {
12116
- description: 'Account is disconnected',
12117
- properties: {
12118
- error_code: {
12119
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12120
- enum: ['account_disconnected'],
12121
- type: 'string',
12122
- },
12123
- is_device_error: { enum: [true], type: 'boolean' },
12124
- message: { type: 'string' },
12125
- },
12126
- required: ['message', 'is_device_error', 'error_code'],
12127
- type: 'object',
11909
+ is_device_error: { enum: [true], type: 'boolean' },
11910
+ message: { type: 'string' },
11911
+ },
11912
+ required: ['message', 'is_device_error', 'error_code'],
11913
+ type: 'object',
11914
+ },
11915
+ {
11916
+ description: 'Device is disconnected',
11917
+ properties: {
11918
+ error_code: {
11919
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11920
+ enum: ['device_disconnected'],
11921
+ type: 'string',
12128
11922
  },
12129
- {
12130
- description: 'Hub is disconnected',
12131
- properties: {
12132
- error_code: {
12133
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12134
- enum: ['hub_disconnected'],
12135
- type: 'string',
12136
- },
12137
- is_device_error: { enum: [true], type: 'boolean' },
12138
- message: { type: 'string' },
12139
- },
12140
- required: ['message', 'is_device_error', 'error_code'],
12141
- type: 'object',
11923
+ is_device_error: { enum: [true], type: 'boolean' },
11924
+ message: { type: 'string' },
11925
+ },
11926
+ required: ['message', 'is_device_error', 'error_code'],
11927
+ type: 'object',
11928
+ },
11929
+ {
11930
+ description: 'The backup access code pool is empty.',
11931
+ properties: {
11932
+ error_code: {
11933
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11934
+ enum: ['empty_backup_access_code_pool'],
11935
+ type: 'string',
12142
11936
  },
12143
- {
12144
- description: 'Device is disconnected',
12145
- properties: {
12146
- error_code: {
12147
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12148
- enum: ['device_disconnected'],
12149
- type: 'string',
12150
- },
12151
- is_device_error: { enum: [true], type: 'boolean' },
12152
- message: { type: 'string' },
12153
- },
12154
- required: ['message', 'is_device_error', 'error_code'],
12155
- type: 'object',
11937
+ is_device_error: { enum: [true], type: 'boolean' },
11938
+ message: { type: 'string' },
11939
+ },
11940
+ required: ['message', 'is_device_error', 'error_code'],
11941
+ type: 'object',
11942
+ },
11943
+ {
11944
+ description: 'User is not authorized to use the August Lock.',
11945
+ properties: {
11946
+ error_code: {
11947
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11948
+ enum: ['august_lock_not_authorized'],
11949
+ type: 'string',
12156
11950
  },
12157
- {
12158
- description: 'The backup access code pool is empty.',
12159
- properties: {
12160
- error_code: {
12161
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12162
- enum: ['empty_backup_access_code_pool'],
12163
- type: 'string',
12164
- },
12165
- is_device_error: { enum: [true], type: 'boolean' },
12166
- message: { type: 'string' },
12167
- },
12168
- required: ['message', 'is_device_error', 'error_code'],
12169
- type: 'object',
11951
+ is_device_error: { enum: [true], type: 'boolean' },
11952
+ message: { type: 'string' },
11953
+ },
11954
+ required: ['message', 'is_device_error', 'error_code'],
11955
+ type: 'object',
11956
+ },
11957
+ {
11958
+ description: 'Lock is not connected to the Seam Bridge.',
11959
+ properties: {
11960
+ error_code: {
11961
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11962
+ enum: ['august_lock_missing_bridge'],
11963
+ type: 'string',
12170
11964
  },
12171
- {
12172
- description: 'User is not authorized to use the August Lock.',
12173
- properties: {
12174
- error_code: {
12175
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12176
- enum: ['august_lock_not_authorized'],
12177
- type: 'string',
12178
- },
12179
- is_device_error: { enum: [true], type: 'boolean' },
12180
- message: { type: 'string' },
12181
- },
12182
- required: ['message', 'is_device_error', 'error_code'],
12183
- type: 'object',
11965
+ is_device_error: { enum: [true], type: 'boolean' },
11966
+ message: { type: 'string' },
11967
+ },
11968
+ required: ['message', 'is_device_error', 'error_code'],
11969
+ type: 'object',
11970
+ },
11971
+ {
11972
+ description: 'Salto site user limit reached.',
11973
+ properties: {
11974
+ error_code: {
11975
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11976
+ enum: ['salto_site_user_limit_reached'],
11977
+ type: 'string',
12184
11978
  },
12185
- {
12186
- description: 'Lock is not connected to the Seam Bridge.',
12187
- properties: {
12188
- error_code: {
12189
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12190
- enum: ['august_lock_missing_bridge'],
12191
- type: 'string',
12192
- },
12193
- is_device_error: { enum: [true], type: 'boolean' },
12194
- message: { type: 'string' },
12195
- },
12196
- required: ['message', 'is_device_error', 'error_code'],
12197
- type: 'object',
11979
+ is_device_error: { enum: [true], type: 'boolean' },
11980
+ message: { type: 'string' },
11981
+ },
11982
+ required: ['message', 'is_device_error', 'error_code'],
11983
+ type: 'object',
11984
+ },
11985
+ {
11986
+ description: 'Lock is not paired with a Gateway.',
11987
+ properties: {
11988
+ error_code: {
11989
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11990
+ enum: ['ttlock_lock_not_paired_to_gateway'],
11991
+ type: 'string',
12198
11992
  },
12199
- {
12200
- description: 'Salto site user limit reached.',
12201
- properties: {
12202
- error_code: {
12203
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12204
- enum: ['salto_site_user_limit_reached'],
12205
- type: 'string',
12206
- },
12207
- is_device_error: { enum: [true], type: 'boolean' },
12208
- message: { type: 'string' },
12209
- },
12210
- required: ['message', 'is_device_error', 'error_code'],
12211
- type: 'object',
11993
+ is_device_error: { enum: [true], type: 'boolean' },
11994
+ message: { type: 'string' },
11995
+ },
11996
+ required: ['message', 'is_device_error', 'error_code'],
11997
+ type: 'object',
11998
+ },
11999
+ {
12000
+ description: 'Missing device credentials.',
12001
+ properties: {
12002
+ error_code: {
12003
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12004
+ enum: ['missing_device_credentials'],
12005
+ type: 'string',
12212
12006
  },
12213
- {
12214
- description: 'Lock is not paired with a Gateway.',
12215
- properties: {
12216
- error_code: {
12217
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12218
- enum: ['ttlock_lock_not_paired_to_gateway'],
12219
- type: 'string',
12220
- },
12221
- is_device_error: { enum: [true], type: 'boolean' },
12222
- message: { type: 'string' },
12223
- },
12224
- required: ['message', 'is_device_error', 'error_code'],
12225
- type: 'object',
12007
+ is_device_error: { enum: [true], type: 'boolean' },
12008
+ message: { type: 'string' },
12009
+ },
12010
+ required: ['message', 'is_device_error', 'error_code'],
12011
+ type: 'object',
12012
+ },
12013
+ {
12014
+ description: 'The auxiliary heat is running.',
12015
+ properties: {
12016
+ error_code: {
12017
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12018
+ enum: ['auxiliary_heat_running'],
12019
+ type: 'string',
12226
12020
  },
12227
- {
12228
- description: 'Missing device credentials.',
12229
- properties: {
12230
- error_code: {
12231
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12232
- enum: ['missing_device_credentials'],
12233
- type: 'string',
12234
- },
12235
- is_device_error: { enum: [true], type: 'boolean' },
12236
- message: { type: 'string' },
12237
- },
12238
- required: ['message', 'is_device_error', 'error_code'],
12239
- type: 'object',
12021
+ is_device_error: { enum: [true], type: 'boolean' },
12022
+ message: { type: 'string' },
12023
+ },
12024
+ required: ['message', 'is_device_error', 'error_code'],
12025
+ type: 'object',
12026
+ },
12027
+ {
12028
+ description: 'Subscription required to connect.',
12029
+ properties: {
12030
+ error_code: {
12031
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12032
+ enum: ['subscription_required'],
12033
+ type: 'string',
12240
12034
  },
12241
- {
12242
- description: 'The auxiliary heat is running.',
12243
- properties: {
12244
- error_code: {
12245
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12246
- enum: ['auxiliary_heat_running'],
12247
- type: 'string',
12248
- },
12249
- is_device_error: { enum: [true], type: 'boolean' },
12250
- message: { type: 'string' },
12251
- },
12252
- required: ['message', 'is_device_error', 'error_code'],
12253
- type: 'object',
12035
+ is_device_error: { enum: [true], type: 'boolean' },
12036
+ message: { type: 'string' },
12037
+ },
12038
+ required: ['message', 'is_device_error', 'error_code'],
12039
+ type: 'object',
12040
+ },
12041
+ {
12042
+ description: 'Account is disconnected.',
12043
+ properties: {
12044
+ error_code: {
12045
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12046
+ enum: ['account_disconnected'],
12047
+ type: 'string',
12254
12048
  },
12255
- {
12256
- description: 'Subscription required to connect.',
12257
- properties: {
12258
- error_code: {
12259
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12260
- enum: ['subscription_required'],
12261
- type: 'string',
12262
- },
12263
- is_device_error: { enum: [true], type: 'boolean' },
12264
- message: { type: 'string' },
12265
- },
12266
- required: ['message', 'is_device_error', 'error_code'],
12267
- type: 'object',
12049
+ is_connected_account_error: {
12050
+ enum: [true],
12051
+ type: 'boolean',
12268
12052
  },
12053
+ message: { type: 'string' },
12054
+ },
12055
+ required: [
12056
+ 'message',
12057
+ 'is_connected_account_error',
12058
+ 'error_code',
12269
12059
  ],
12060
+ type: 'object',
12270
12061
  },
12271
12062
  {
12272
- oneOf: [
12273
- {
12274
- description: 'Account is disconnected.',
12275
- properties: {
12276
- error_code: {
12277
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12278
- enum: ['account_disconnected'],
12279
- type: 'string',
12280
- },
12281
- is_connected_account_error: {
12282
- enum: [true],
12283
- type: 'boolean',
12284
- },
12285
- message: { type: 'string' },
12286
- },
12287
- required: [
12288
- 'message',
12289
- 'is_connected_account_error',
12290
- 'error_code',
12291
- ],
12292
- type: 'object',
12063
+ description: 'Credentials provided were invalid.',
12064
+ properties: {
12065
+ error_code: {
12066
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12067
+ enum: ['invalid_credentials'],
12068
+ type: 'string',
12293
12069
  },
12294
- {
12295
- description: 'Credentials provided were invalid.',
12296
- properties: {
12297
- error_code: {
12298
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12299
- enum: ['invalid_credentials'],
12300
- type: 'string',
12301
- },
12302
- is_connected_account_error: {
12303
- enum: [true],
12304
- type: 'boolean',
12305
- },
12306
- message: { type: 'string' },
12307
- },
12308
- required: [
12309
- 'message',
12310
- 'is_connected_account_error',
12311
- 'error_code',
12312
- ],
12313
- type: 'object',
12070
+ is_connected_account_error: {
12071
+ enum: [true],
12072
+ type: 'boolean',
12314
12073
  },
12074
+ message: { type: 'string' },
12075
+ },
12076
+ required: [
12077
+ 'message',
12078
+ 'is_connected_account_error',
12079
+ 'error_code',
12315
12080
  ],
12081
+ type: 'object',
12316
12082
  },
12317
12083
  ],
12318
12084
  },
@@ -12339,6 +12105,7 @@ export default {
12339
12105
  warnings: {
12340
12106
  description: '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.',
12341
12107
  items: {
12108
+ discriminator: { propertyName: 'warning_code' },
12342
12109
  oneOf: [
12343
12110
  {
12344
12111
  description: 'Failed to set code on Smart Things device.',
@@ -12738,6 +12505,7 @@ export default {
12738
12505
  description: 'Warnings associated with the `acs_credential`.',
12739
12506
  items: {
12740
12507
  description: 'Warning associated with the `acs_credential`.',
12508
+ discriminator: { propertyName: 'warning_code' },
12741
12509
  oneOf: [
12742
12510
  {
12743
12511
  description: 'Indicates that the credential is waiting to be issued.',
@@ -12944,6 +12712,7 @@ export default {
12944
12712
  description: 'Errors associated with the `acs_user`.',
12945
12713
  items: {
12946
12714
  description: 'Error associated with the `acs_user`.',
12715
+ discriminator: { propertyName: 'error_code' },
12947
12716
  oneOf: [
12948
12717
  {
12949
12718
  description: 'Indicates that the ACS user was deleted from the ACS system outside of Seam.',
@@ -13114,6 +12883,7 @@ export default {
13114
12883
  description: 'Warnings associated with the `acs_user`.',
13115
12884
  items: {
13116
12885
  description: 'Warning associated with the `acs_user`.',
12886
+ discriminator: { propertyName: 'warning_code' },
13117
12887
  oneOf: [
13118
12888
  {
13119
12889
  description: 'Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.',
@@ -13271,239 +13041,217 @@ export default {
13271
13041
  errors: {
13272
13042
  description: '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.',
13273
13043
  items: {
13044
+ discriminator: { propertyName: 'error_code' },
13274
13045
  oneOf: [
13275
13046
  {
13276
- description: 'Error associated with the `device`.',
13277
- oneOf: [
13278
- {
13279
- description: 'Device is offline',
13280
- properties: {
13281
- error_code: {
13282
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13283
- enum: ['device_offline'],
13284
- type: 'string',
13285
- },
13286
- is_device_error: { enum: [true], type: 'boolean' },
13287
- message: { type: 'string' },
13288
- },
13289
- required: ['message', 'is_device_error', 'error_code'],
13290
- type: 'object',
13047
+ description: 'Device is offline',
13048
+ properties: {
13049
+ error_code: {
13050
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13051
+ enum: ['device_offline'],
13052
+ type: 'string',
13053
+ },
13054
+ is_device_error: { enum: [true], type: 'boolean' },
13055
+ message: { type: 'string' },
13056
+ },
13057
+ required: ['message', 'is_device_error', 'error_code'],
13058
+ type: 'object',
13059
+ },
13060
+ {
13061
+ description: 'Device has been removed',
13062
+ properties: {
13063
+ error_code: {
13064
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13065
+ enum: ['device_removed'],
13066
+ type: 'string',
13291
13067
  },
13292
- {
13293
- description: 'Device has been removed',
13294
- properties: {
13295
- error_code: {
13296
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13297
- enum: ['device_removed'],
13298
- type: 'string',
13299
- },
13300
- is_device_error: { enum: [true], type: 'boolean' },
13301
- message: { type: 'string' },
13302
- },
13303
- required: ['message', 'is_device_error', 'error_code'],
13304
- type: 'object',
13068
+ is_device_error: { enum: [true], type: 'boolean' },
13069
+ message: { type: 'string' },
13070
+ },
13071
+ required: ['message', 'is_device_error', 'error_code'],
13072
+ type: 'object',
13073
+ },
13074
+ {
13075
+ description: 'Hub is disconnected',
13076
+ properties: {
13077
+ error_code: {
13078
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13079
+ enum: ['hub_disconnected'],
13080
+ type: 'string',
13305
13081
  },
13306
- {
13307
- description: 'Account is disconnected',
13308
- properties: {
13309
- error_code: {
13310
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13311
- enum: ['account_disconnected'],
13312
- type: 'string',
13313
- },
13314
- is_device_error: { enum: [true], type: 'boolean' },
13315
- message: { type: 'string' },
13316
- },
13317
- required: ['message', 'is_device_error', 'error_code'],
13318
- type: 'object',
13082
+ is_device_error: { enum: [true], type: 'boolean' },
13083
+ message: { type: 'string' },
13084
+ },
13085
+ required: ['message', 'is_device_error', 'error_code'],
13086
+ type: 'object',
13087
+ },
13088
+ {
13089
+ description: 'Device is disconnected',
13090
+ properties: {
13091
+ error_code: {
13092
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13093
+ enum: ['device_disconnected'],
13094
+ type: 'string',
13319
13095
  },
13320
- {
13321
- description: 'Hub is disconnected',
13322
- properties: {
13323
- error_code: {
13324
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13325
- enum: ['hub_disconnected'],
13326
- type: 'string',
13327
- },
13328
- is_device_error: { enum: [true], type: 'boolean' },
13329
- message: { type: 'string' },
13330
- },
13331
- required: ['message', 'is_device_error', 'error_code'],
13332
- type: 'object',
13096
+ is_device_error: { enum: [true], type: 'boolean' },
13097
+ message: { type: 'string' },
13098
+ },
13099
+ required: ['message', 'is_device_error', 'error_code'],
13100
+ type: 'object',
13101
+ },
13102
+ {
13103
+ description: 'The backup access code pool is empty.',
13104
+ properties: {
13105
+ error_code: {
13106
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13107
+ enum: ['empty_backup_access_code_pool'],
13108
+ type: 'string',
13333
13109
  },
13334
- {
13335
- description: 'Device is disconnected',
13336
- properties: {
13337
- error_code: {
13338
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13339
- enum: ['device_disconnected'],
13340
- type: 'string',
13341
- },
13342
- is_device_error: { enum: [true], type: 'boolean' },
13343
- message: { type: 'string' },
13344
- },
13345
- required: ['message', 'is_device_error', 'error_code'],
13346
- type: 'object',
13110
+ is_device_error: { enum: [true], type: 'boolean' },
13111
+ message: { type: 'string' },
13112
+ },
13113
+ required: ['message', 'is_device_error', 'error_code'],
13114
+ type: 'object',
13115
+ },
13116
+ {
13117
+ description: 'User is not authorized to use the August Lock.',
13118
+ properties: {
13119
+ error_code: {
13120
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13121
+ enum: ['august_lock_not_authorized'],
13122
+ type: 'string',
13347
13123
  },
13348
- {
13349
- description: 'The backup access code pool is empty.',
13350
- properties: {
13351
- error_code: {
13352
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13353
- enum: ['empty_backup_access_code_pool'],
13354
- type: 'string',
13355
- },
13356
- is_device_error: { enum: [true], type: 'boolean' },
13357
- message: { type: 'string' },
13358
- },
13359
- required: ['message', 'is_device_error', 'error_code'],
13360
- type: 'object',
13124
+ is_device_error: { enum: [true], type: 'boolean' },
13125
+ message: { type: 'string' },
13126
+ },
13127
+ required: ['message', 'is_device_error', 'error_code'],
13128
+ type: 'object',
13129
+ },
13130
+ {
13131
+ description: 'Lock is not connected to the Seam Bridge.',
13132
+ properties: {
13133
+ error_code: {
13134
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13135
+ enum: ['august_lock_missing_bridge'],
13136
+ type: 'string',
13361
13137
  },
13362
- {
13363
- description: 'User is not authorized to use the August Lock.',
13364
- properties: {
13365
- error_code: {
13366
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13367
- enum: ['august_lock_not_authorized'],
13368
- type: 'string',
13369
- },
13370
- is_device_error: { enum: [true], type: 'boolean' },
13371
- message: { type: 'string' },
13372
- },
13373
- required: ['message', 'is_device_error', 'error_code'],
13374
- type: 'object',
13138
+ is_device_error: { enum: [true], type: 'boolean' },
13139
+ message: { type: 'string' },
13140
+ },
13141
+ required: ['message', 'is_device_error', 'error_code'],
13142
+ type: 'object',
13143
+ },
13144
+ {
13145
+ description: 'Salto site user limit reached.',
13146
+ properties: {
13147
+ error_code: {
13148
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13149
+ enum: ['salto_site_user_limit_reached'],
13150
+ type: 'string',
13375
13151
  },
13376
- {
13377
- description: 'Lock is not connected to the Seam Bridge.',
13378
- properties: {
13379
- error_code: {
13380
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13381
- enum: ['august_lock_missing_bridge'],
13382
- type: 'string',
13383
- },
13384
- is_device_error: { enum: [true], type: 'boolean' },
13385
- message: { type: 'string' },
13386
- },
13387
- required: ['message', 'is_device_error', 'error_code'],
13388
- type: 'object',
13152
+ is_device_error: { enum: [true], type: 'boolean' },
13153
+ message: { type: 'string' },
13154
+ },
13155
+ required: ['message', 'is_device_error', 'error_code'],
13156
+ type: 'object',
13157
+ },
13158
+ {
13159
+ description: 'Lock is not paired with a Gateway.',
13160
+ properties: {
13161
+ error_code: {
13162
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13163
+ enum: ['ttlock_lock_not_paired_to_gateway'],
13164
+ type: 'string',
13389
13165
  },
13390
- {
13391
- description: 'Salto site user limit reached.',
13392
- properties: {
13393
- error_code: {
13394
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13395
- enum: ['salto_site_user_limit_reached'],
13396
- type: 'string',
13397
- },
13398
- is_device_error: { enum: [true], type: 'boolean' },
13399
- message: { type: 'string' },
13400
- },
13401
- required: ['message', 'is_device_error', 'error_code'],
13402
- type: 'object',
13166
+ is_device_error: { enum: [true], type: 'boolean' },
13167
+ message: { type: 'string' },
13168
+ },
13169
+ required: ['message', 'is_device_error', 'error_code'],
13170
+ type: 'object',
13171
+ },
13172
+ {
13173
+ description: 'Missing device credentials.',
13174
+ properties: {
13175
+ error_code: {
13176
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13177
+ enum: ['missing_device_credentials'],
13178
+ type: 'string',
13403
13179
  },
13404
- {
13405
- description: 'Lock is not paired with a Gateway.',
13406
- properties: {
13407
- error_code: {
13408
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13409
- enum: ['ttlock_lock_not_paired_to_gateway'],
13410
- type: 'string',
13411
- },
13412
- is_device_error: { enum: [true], type: 'boolean' },
13413
- message: { type: 'string' },
13414
- },
13415
- required: ['message', 'is_device_error', 'error_code'],
13416
- type: 'object',
13180
+ is_device_error: { enum: [true], type: 'boolean' },
13181
+ message: { type: 'string' },
13182
+ },
13183
+ required: ['message', 'is_device_error', 'error_code'],
13184
+ type: 'object',
13185
+ },
13186
+ {
13187
+ description: 'The auxiliary heat is running.',
13188
+ properties: {
13189
+ error_code: {
13190
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13191
+ enum: ['auxiliary_heat_running'],
13192
+ type: 'string',
13417
13193
  },
13418
- {
13419
- description: 'Missing device credentials.',
13420
- properties: {
13421
- error_code: {
13422
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13423
- enum: ['missing_device_credentials'],
13424
- type: 'string',
13425
- },
13426
- is_device_error: { enum: [true], type: 'boolean' },
13427
- message: { type: 'string' },
13428
- },
13429
- required: ['message', 'is_device_error', 'error_code'],
13430
- type: 'object',
13194
+ is_device_error: { enum: [true], type: 'boolean' },
13195
+ message: { type: 'string' },
13196
+ },
13197
+ required: ['message', 'is_device_error', 'error_code'],
13198
+ type: 'object',
13199
+ },
13200
+ {
13201
+ description: 'Subscription required to connect.',
13202
+ properties: {
13203
+ error_code: {
13204
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13205
+ enum: ['subscription_required'],
13206
+ type: 'string',
13431
13207
  },
13432
- {
13433
- description: 'The auxiliary heat is running.',
13434
- properties: {
13435
- error_code: {
13436
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13437
- enum: ['auxiliary_heat_running'],
13438
- type: 'string',
13439
- },
13440
- is_device_error: { enum: [true], type: 'boolean' },
13441
- message: { type: 'string' },
13442
- },
13443
- required: ['message', 'is_device_error', 'error_code'],
13444
- type: 'object',
13208
+ is_device_error: { enum: [true], type: 'boolean' },
13209
+ message: { type: 'string' },
13210
+ },
13211
+ required: ['message', 'is_device_error', 'error_code'],
13212
+ type: 'object',
13213
+ },
13214
+ {
13215
+ description: 'Account is disconnected.',
13216
+ properties: {
13217
+ error_code: {
13218
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13219
+ enum: ['account_disconnected'],
13220
+ type: 'string',
13445
13221
  },
13446
- {
13447
- description: 'Subscription required to connect.',
13448
- properties: {
13449
- error_code: {
13450
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13451
- enum: ['subscription_required'],
13452
- type: 'string',
13453
- },
13454
- is_device_error: { enum: [true], type: 'boolean' },
13455
- message: { type: 'string' },
13456
- },
13457
- required: ['message', 'is_device_error', 'error_code'],
13458
- type: 'object',
13222
+ is_connected_account_error: {
13223
+ enum: [true],
13224
+ type: 'boolean',
13459
13225
  },
13226
+ message: { type: 'string' },
13227
+ },
13228
+ required: [
13229
+ 'message',
13230
+ 'is_connected_account_error',
13231
+ 'error_code',
13460
13232
  ],
13233
+ type: 'object',
13461
13234
  },
13462
13235
  {
13463
- oneOf: [
13464
- {
13465
- description: 'Account is disconnected.',
13466
- properties: {
13467
- error_code: {
13468
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13469
- enum: ['account_disconnected'],
13470
- type: 'string',
13471
- },
13472
- is_connected_account_error: {
13473
- enum: [true],
13474
- type: 'boolean',
13475
- },
13476
- message: { type: 'string' },
13477
- },
13478
- required: [
13479
- 'message',
13480
- 'is_connected_account_error',
13481
- 'error_code',
13482
- ],
13483
- type: 'object',
13236
+ description: 'Credentials provided were invalid.',
13237
+ properties: {
13238
+ error_code: {
13239
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13240
+ enum: ['invalid_credentials'],
13241
+ type: 'string',
13484
13242
  },
13485
- {
13486
- description: 'Credentials provided were invalid.',
13487
- properties: {
13488
- error_code: {
13489
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13490
- enum: ['invalid_credentials'],
13491
- type: 'string',
13492
- },
13493
- is_connected_account_error: {
13494
- enum: [true],
13495
- type: 'boolean',
13496
- },
13497
- message: { type: 'string' },
13498
- },
13499
- required: [
13500
- 'message',
13501
- 'is_connected_account_error',
13502
- 'error_code',
13503
- ],
13504
- type: 'object',
13243
+ is_connected_account_error: {
13244
+ enum: [true],
13245
+ type: 'boolean',
13505
13246
  },
13247
+ message: { type: 'string' },
13248
+ },
13249
+ required: [
13250
+ 'message',
13251
+ 'is_connected_account_error',
13252
+ 'error_code',
13506
13253
  ],
13254
+ type: 'object',
13507
13255
  },
13508
13256
  ],
13509
13257
  },
@@ -13648,6 +13396,7 @@ export default {
13648
13396
  warnings: {
13649
13397
  description: '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.',
13650
13398
  items: {
13399
+ discriminator: { propertyName: 'warning_code' },
13651
13400
  oneOf: [
13652
13401
  {
13653
13402
  description: 'Backup access code unhealthy.',
@@ -24376,6 +24125,7 @@ export default {
24376
24125
  },
24377
24126
  '/thermostats/simulate/hvac_mode_adjusted': {
24378
24127
  post: {
24128
+ description: '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).',
24379
24129
  operationId: 'thermostatsSimulateHvacModeAdjustedPost',
24380
24130
  requestBody: {
24381
24131
  content: {
@@ -24385,8 +24135,16 @@ export default {
24385
24135
  oneOf: [
24386
24136
  {
24387
24137
  properties: {
24388
- device_id: { format: 'uuid', type: 'string' },
24389
- hvac_mode: { enum: ['off'], type: 'string' },
24138
+ device_id: {
24139
+ description: 'ID of the desired thermostat device.',
24140
+ format: 'uuid',
24141
+ type: 'string',
24142
+ },
24143
+ hvac_mode: {
24144
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24145
+ enum: ['off'],
24146
+ type: 'string',
24147
+ },
24390
24148
  },
24391
24149
  required: ['hvac_mode', 'device_id'],
24392
24150
  type: 'object',
@@ -24394,31 +24152,51 @@ export default {
24394
24152
  {
24395
24153
  properties: {
24396
24154
  cooling_set_point_celsius: {
24155
+ description: '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`.',
24397
24156
  format: 'float',
24398
24157
  type: 'number',
24399
24158
  },
24400
24159
  cooling_set_point_fahrenheit: {
24160
+ description: '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`.',
24401
24161
  format: 'float',
24402
24162
  type: 'number',
24403
24163
  },
24404
- device_id: { format: 'uuid', type: 'string' },
24405
- hvac_mode: { enum: ['cool'], type: 'string' },
24164
+ device_id: {
24165
+ description: 'ID of the desired thermostat device.',
24166
+ format: 'uuid',
24167
+ type: 'string',
24168
+ },
24169
+ hvac_mode: {
24170
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24171
+ enum: ['cool'],
24172
+ type: 'string',
24173
+ },
24406
24174
  },
24407
24175
  required: ['hvac_mode', 'device_id'],
24408
24176
  type: 'object',
24409
24177
  },
24410
24178
  {
24411
24179
  properties: {
24412
- device_id: { format: 'uuid', type: 'string' },
24180
+ device_id: {
24181
+ description: 'ID of the desired thermostat device.',
24182
+ format: 'uuid',
24183
+ type: 'string',
24184
+ },
24413
24185
  heating_set_point_celsius: {
24186
+ description: '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`.',
24414
24187
  format: 'float',
24415
24188
  type: 'number',
24416
24189
  },
24417
24190
  heating_set_point_fahrenheit: {
24191
+ description: '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`.',
24418
24192
  format: 'float',
24419
24193
  type: 'number',
24420
24194
  },
24421
- hvac_mode: { enum: ['heat'], type: 'string' },
24195
+ hvac_mode: {
24196
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24197
+ enum: ['heat'],
24198
+ type: 'string',
24199
+ },
24422
24200
  },
24423
24201
  required: ['hvac_mode', 'device_id'],
24424
24202
  type: 'object',
@@ -24426,23 +24204,35 @@ export default {
24426
24204
  {
24427
24205
  properties: {
24428
24206
  cooling_set_point_celsius: {
24207
+ description: '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`.',
24429
24208
  format: 'float',
24430
24209
  type: 'number',
24431
24210
  },
24432
24211
  cooling_set_point_fahrenheit: {
24212
+ description: '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`.',
24433
24213
  format: 'float',
24434
24214
  type: 'number',
24435
24215
  },
24436
- device_id: { format: 'uuid', type: 'string' },
24216
+ device_id: {
24217
+ description: 'ID of the desired thermostat device.',
24218
+ format: 'uuid',
24219
+ type: 'string',
24220
+ },
24437
24221
  heating_set_point_celsius: {
24222
+ description: '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`.',
24438
24223
  format: 'float',
24439
24224
  type: 'number',
24440
24225
  },
24441
24226
  heating_set_point_fahrenheit: {
24227
+ description: '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`.',
24442
24228
  format: 'float',
24443
24229
  type: 'number',
24444
24230
  },
24445
- hvac_mode: { enum: ['heat_cool'], type: 'string' },
24231
+ hvac_mode: {
24232
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24233
+ enum: ['heat_cool'],
24234
+ type: 'string',
24235
+ },
24446
24236
  },
24447
24237
  required: ['hvac_mode', 'device_id'],
24448
24238
  type: 'object',
@@ -24478,19 +24268,33 @@ export default {
24478
24268
  'x-fern-sdk-group-name': ['thermostats', 'simulate'],
24479
24269
  'x-fern-sdk-method-name': 'hvac_mode_adjusted',
24480
24270
  'x-response-key': null,
24271
+ 'x-title': 'HVAC Mode Adjusted',
24481
24272
  },
24482
24273
  },
24483
24274
  '/thermostats/simulate/temperature_reached': {
24484
24275
  post: {
24276
+ description: '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).',
24485
24277
  operationId: 'thermostatsSimulateTemperatureReachedPost',
24486
24278
  requestBody: {
24487
24279
  content: {
24488
24280
  'application/json': {
24489
24281
  schema: {
24490
24282
  properties: {
24491
- device_id: { format: 'uuid', type: 'string' },
24492
- temperature_celsius: { format: 'float', type: 'number' },
24493
- temperature_fahrenheit: { format: 'float', type: 'number' },
24283
+ device_id: {
24284
+ description: 'ID of the desired thermostat device.',
24285
+ format: 'uuid',
24286
+ type: 'string',
24287
+ },
24288
+ temperature_celsius: {
24289
+ description: 'Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.',
24290
+ format: 'float',
24291
+ type: 'number',
24292
+ },
24293
+ temperature_fahrenheit: {
24294
+ description: 'Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.',
24295
+ format: 'float',
24296
+ type: 'number',
24297
+ },
24494
24298
  },
24495
24299
  required: ['device_id'],
24496
24300
  type: 'object',
@@ -24524,6 +24328,7 @@ export default {
24524
24328
  'x-fern-sdk-group-name': ['thermostats', 'simulate'],
24525
24329
  'x-fern-sdk-method-name': 'temperature_reached',
24526
24330
  'x-response-key': null,
24331
+ 'x-title': 'Temperature Reached',
24527
24332
  },
24528
24333
  },
24529
24334
  '/thermostats/update_climate_preset': {