@seamapi/types 1.332.0 → 1.333.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/connect.cjs +1578 -318
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3297 -472
  4. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +902 -35
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js +238 -6
  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 +568 -25
  8. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +85 -23
  9. package/lib/seam/connect/models/connected-accounts/connected-account.js +27 -9
  10. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  11. package/lib/seam/connect/models/devices/device.d.ts +28 -7
  12. package/lib/seam/connect/models/devices/phone.d.ts +28 -7
  13. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +28 -7
  14. package/lib/seam/connect/models/events/acs/{access_groups.js → access-groups.js} +1 -1
  15. package/lib/seam/connect/models/events/acs/{access_groups.js.map → access-groups.js.map} +1 -1
  16. package/lib/seam/connect/models/events/acs/index.js +1 -1
  17. package/lib/seam/connect/models/events/index.d.ts +1 -0
  18. package/lib/seam/connect/models/events/index.js +1 -0
  19. package/lib/seam/connect/models/events/index.js.map +1 -1
  20. package/lib/seam/connect/models/events/seam-event.d.ts +1 -0
  21. package/lib/seam/connect/models/events/seam-event.js +2 -0
  22. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  23. package/lib/seam/connect/openapi.d.ts +174 -164
  24. package/lib/seam/connect/openapi.js +1331 -205
  25. package/lib/seam/connect/openapi.js.map +1 -1
  26. package/lib/seam/connect/route-types.d.ts +1539 -210
  27. package/package.json +1 -1
  28. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +282 -7
  29. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +32 -9
  30. package/src/lib/seam/connect/models/events/acs/index.ts +1 -1
  31. package/src/lib/seam/connect/models/events/index.ts +1 -0
  32. package/src/lib/seam/connect/models/events/seam-event.ts +10 -0
  33. package/src/lib/seam/connect/openapi.ts +1452 -229
  34. package/src/lib/seam/connect/route-types.ts +2349 -654
  35. /package/lib/seam/connect/models/events/acs/{access_groups.d.ts → access-groups.d.ts} +0 -0
  36. /package/src/lib/seam/connect/models/events/acs/{access_groups.ts → access-groups.ts} +0 -0
@@ -39,13 +39,354 @@ export default {
39
39
  items: {
40
40
  oneOf: [
41
41
  {
42
- properties: {
43
- error_code: { type: 'string' },
44
- is_access_code_error: { enum: [true], type: 'boolean' },
45
- message: { type: 'string' },
46
- },
47
- required: ['message', 'is_access_code_error', 'error_code'],
48
- type: 'object',
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',
80
+ },
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',
96
+ ],
97
+ type: 'object',
98
+ },
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',
116
+ },
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',
134
+ },
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',
152
+ },
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',
170
+ },
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',
188
+ },
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',
208
+ },
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',
224
+ ],
225
+ type: 'object',
226
+ },
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',
244
+ },
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',
262
+ },
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',
280
+ },
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',
298
+ },
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',
316
+ },
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',
334
+ },
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
+ ],
49
390
  },
50
391
  {
51
392
  description: 'Error associated with the `device`.',
@@ -235,20 +576,50 @@ export default {
235
576
  ],
236
577
  },
237
578
  {
238
- properties: {
239
- error_code: { type: 'string' },
240
- is_connected_account_error: {
241
- enum: [true],
242
- type: 'boolean',
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',
243
621
  },
244
- message: { type: 'string' },
245
- },
246
- required: [
247
- 'message',
248
- 'is_connected_account_error',
249
- 'error_code',
250
622
  ],
251
- type: 'object',
252
623
  },
253
624
  ],
254
625
  },
@@ -317,12 +688,138 @@ export default {
317
688
  warnings: {
318
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.',
319
690
  items: {
320
- properties: {
321
- message: { type: 'string' },
322
- warning_code: { type: 'string' },
323
- },
324
- required: ['message', 'warning_code'],
325
- type: 'object',
691
+ oneOf: [
692
+ {
693
+ description: 'Failed to set code on Smart Things device.',
694
+ 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'],
699
+ type: 'string',
700
+ },
701
+ },
702
+ required: ['message', 'warning_code'],
703
+ type: 'object',
704
+ },
705
+ {
706
+ description: 'Duplicate access code detected.',
707
+ 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'],
712
+ type: 'string',
713
+ },
714
+ },
715
+ required: ['message', 'warning_code'],
716
+ type: 'object',
717
+ },
718
+ {
719
+ description: 'Received an error when attempting to create this code.',
720
+ 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'],
725
+ type: 'string',
726
+ },
727
+ },
728
+ required: ['message', 'warning_code'],
729
+ type: 'object',
730
+ },
731
+ {
732
+ description: 'Code was modified or removed externally after Seam successfully set it on the device.',
733
+ 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'],
738
+ type: 'string',
739
+ },
740
+ },
741
+ required: ['message', 'warning_code'],
742
+ type: 'object',
743
+ },
744
+ {
745
+ description: 'Delay in setting code on device.',
746
+ 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'],
751
+ type: 'string',
752
+ },
753
+ },
754
+ required: ['message', 'warning_code'],
755
+ type: 'object',
756
+ },
757
+ {
758
+ description: 'Delay in removing code from device.',
759
+ 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'],
764
+ type: 'string',
765
+ },
766
+ },
767
+ required: ['message', 'warning_code'],
768
+ type: 'object',
769
+ },
770
+ {
771
+ description: 'Third party integration detected that may cause access codes to fail.',
772
+ 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'],
777
+ type: 'string',
778
+ },
779
+ },
780
+ required: ['message', 'warning_code'],
781
+ type: 'object',
782
+ },
783
+ {
784
+ description: 'Access code has not yet been fully moved to the device.',
785
+ properties: {
786
+ 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'],
790
+ type: 'string',
791
+ },
792
+ },
793
+ required: ['message', 'warning_code'],
794
+ type: 'object',
795
+ },
796
+ {
797
+ description: 'Algopins must be used within 24 hours.',
798
+ properties: {
799
+ 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'],
803
+ type: 'string',
804
+ },
805
+ },
806
+ required: ['message', 'warning_code'],
807
+ type: 'object',
808
+ },
809
+ {
810
+ description: 'Management was transferred to another workspace.',
811
+ properties: {
812
+ 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'],
816
+ type: 'string',
817
+ },
818
+ },
819
+ required: ['message', 'warning_code'],
820
+ type: 'object',
821
+ },
822
+ ],
326
823
  },
327
824
  type: 'array',
328
825
  },
@@ -4265,13 +4762,50 @@ export default {
4265
4762
  },
4266
4763
  errors: {
4267
4764
  items: {
4268
- properties: {
4269
- error_code: { type: 'string' },
4270
- is_connected_account_error: { enum: [true], type: 'boolean' },
4271
- message: { type: 'string' },
4272
- },
4273
- required: ['message', 'is_connected_account_error', 'error_code'],
4274
- type: 'object',
4765
+ oneOf: [
4766
+ {
4767
+ description: 'Account is disconnected.',
4768
+ properties: {
4769
+ error_code: {
4770
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4771
+ enum: ['account_disconnected'],
4772
+ type: 'string',
4773
+ },
4774
+ is_connected_account_error: {
4775
+ enum: [true],
4776
+ type: 'boolean',
4777
+ },
4778
+ message: { type: 'string' },
4779
+ },
4780
+ required: [
4781
+ 'message',
4782
+ 'is_connected_account_error',
4783
+ 'error_code',
4784
+ ],
4785
+ type: 'object',
4786
+ },
4787
+ {
4788
+ description: 'Credentials provided were invalid.',
4789
+ properties: {
4790
+ error_code: {
4791
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4792
+ enum: ['invalid_credentials'],
4793
+ type: 'string',
4794
+ },
4795
+ is_connected_account_error: {
4796
+ enum: [true],
4797
+ type: 'boolean',
4798
+ },
4799
+ message: { type: 'string' },
4800
+ },
4801
+ required: [
4802
+ 'message',
4803
+ 'is_connected_account_error',
4804
+ 'error_code',
4805
+ ],
4806
+ type: 'object',
4807
+ },
4808
+ ],
4275
4809
  },
4276
4810
  type: 'array',
4277
4811
  },
@@ -4290,9 +4824,14 @@ export default {
4290
4824
  description: 'Warning associated with the `connected_account`.',
4291
4825
  oneOf: [
4292
4826
  {
4827
+ description: 'Scheduled downtime for account planned.',
4293
4828
  properties: {
4294
4829
  message: { type: 'string' },
4295
- warning_code: { type: 'string' },
4830
+ warning_code: {
4831
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4832
+ enum: ['scheduled_maintenance_window'],
4833
+ type: 'string',
4834
+ },
4296
4835
  },
4297
4836
  required: ['message', 'warning_code'],
4298
4837
  type: 'object',
@@ -4621,20 +5160,50 @@ export default {
4621
5160
  ],
4622
5161
  },
4623
5162
  {
4624
- properties: {
4625
- error_code: { type: 'string' },
4626
- is_connected_account_error: {
4627
- enum: [true],
4628
- type: 'boolean',
5163
+ oneOf: [
5164
+ {
5165
+ description: 'Account is disconnected.',
5166
+ properties: {
5167
+ error_code: {
5168
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5169
+ enum: ['account_disconnected'],
5170
+ type: 'string',
5171
+ },
5172
+ is_connected_account_error: {
5173
+ enum: [true],
5174
+ type: 'boolean',
5175
+ },
5176
+ message: { type: 'string' },
5177
+ },
5178
+ required: [
5179
+ 'message',
5180
+ 'is_connected_account_error',
5181
+ 'error_code',
5182
+ ],
5183
+ type: 'object',
5184
+ },
5185
+ {
5186
+ description: 'Credentials provided were invalid.',
5187
+ properties: {
5188
+ error_code: {
5189
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5190
+ enum: ['invalid_credentials'],
5191
+ type: 'string',
5192
+ },
5193
+ is_connected_account_error: {
5194
+ enum: [true],
5195
+ type: 'boolean',
5196
+ },
5197
+ message: { type: 'string' },
5198
+ },
5199
+ required: [
5200
+ 'message',
5201
+ 'is_connected_account_error',
5202
+ 'error_code',
5203
+ ],
5204
+ type: 'object',
4629
5205
  },
4630
- message: { type: 'string' },
4631
- },
4632
- required: [
4633
- 'message',
4634
- 'is_connected_account_error',
4635
- 'error_code',
4636
5206
  ],
4637
- type: 'object',
4638
5207
  },
4639
5208
  ],
4640
5209
  },
@@ -10461,20 +11030,50 @@ export default {
10461
11030
  ],
10462
11031
  },
10463
11032
  {
10464
- properties: {
10465
- error_code: { type: 'string' },
10466
- is_connected_account_error: {
10467
- enum: [true],
10468
- type: 'boolean',
11033
+ oneOf: [
11034
+ {
11035
+ description: 'Account is disconnected.',
11036
+ properties: {
11037
+ error_code: {
11038
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11039
+ enum: ['account_disconnected'],
11040
+ type: 'string',
11041
+ },
11042
+ is_connected_account_error: {
11043
+ enum: [true],
11044
+ type: 'boolean',
11045
+ },
11046
+ message: { type: 'string' },
11047
+ },
11048
+ required: [
11049
+ 'message',
11050
+ 'is_connected_account_error',
11051
+ 'error_code',
11052
+ ],
11053
+ type: 'object',
11054
+ },
11055
+ {
11056
+ description: 'Credentials provided were invalid.',
11057
+ properties: {
11058
+ error_code: {
11059
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11060
+ enum: ['invalid_credentials'],
11061
+ type: 'string',
11062
+ },
11063
+ is_connected_account_error: {
11064
+ enum: [true],
11065
+ type: 'boolean',
11066
+ },
11067
+ message: { type: 'string' },
11068
+ },
11069
+ required: [
11070
+ 'message',
11071
+ 'is_connected_account_error',
11072
+ 'error_code',
11073
+ ],
11074
+ type: 'object',
10469
11075
  },
10470
- message: { type: 'string' },
10471
- },
10472
- required: [
10473
- 'message',
10474
- 'is_connected_account_error',
10475
- 'error_code',
10476
11076
  ],
10477
- type: 'object',
10478
11077
  },
10479
11078
  ],
10480
11079
  },
@@ -10868,13 +11467,354 @@ export default {
10868
11467
  items: {
10869
11468
  oneOf: [
10870
11469
  {
10871
- properties: {
10872
- error_code: { type: 'string' },
10873
- is_access_code_error: { enum: [true], type: 'boolean' },
10874
- message: { type: 'string' },
10875
- },
10876
- required: ['message', 'is_access_code_error', 'error_code'],
10877
- type: 'object',
11470
+ oneOf: [
11471
+ {
11472
+ description: 'Failed to set code on Smart Things device.',
11473
+ properties: {
11474
+ error_code: {
11475
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11476
+ enum: ['smartthings_failed_to_set_access_code'],
11477
+ type: 'string',
11478
+ },
11479
+ is_access_code_error: { enum: [true], type: 'boolean' },
11480
+ message: { type: 'string' },
11481
+ },
11482
+ required: [
11483
+ 'message',
11484
+ 'is_access_code_error',
11485
+ 'error_code',
11486
+ ],
11487
+ type: 'object',
11488
+ },
11489
+ {
11490
+ description: 'Failed to set code after multiple retries.',
11491
+ properties: {
11492
+ error_code: {
11493
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11494
+ enum: [
11495
+ 'smartthings_failed_to_set_after_multiple_retries',
11496
+ ],
11497
+ type: 'string',
11498
+ },
11499
+ is_access_code_error: { enum: [true], type: 'boolean' },
11500
+ message: { type: 'string' },
11501
+ },
11502
+ required: [
11503
+ 'message',
11504
+ 'is_access_code_error',
11505
+ 'error_code',
11506
+ ],
11507
+ type: 'object',
11508
+ },
11509
+ {
11510
+ description: 'Failed to set code on device.',
11511
+ properties: {
11512
+ error_code: {
11513
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11514
+ enum: ['failed_to_set_on_device'],
11515
+ type: 'string',
11516
+ },
11517
+ is_access_code_error: { enum: [true], type: 'boolean' },
11518
+ message: { type: 'string' },
11519
+ },
11520
+ required: [
11521
+ 'message',
11522
+ 'is_access_code_error',
11523
+ 'error_code',
11524
+ ],
11525
+ type: 'object',
11526
+ },
11527
+ {
11528
+ description: 'Failed to remove code from device.',
11529
+ properties: {
11530
+ error_code: {
11531
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11532
+ enum: ['failed_to_remove_from_device'],
11533
+ type: 'string',
11534
+ },
11535
+ is_access_code_error: { enum: [true], type: 'boolean' },
11536
+ message: { type: 'string' },
11537
+ },
11538
+ required: [
11539
+ 'message',
11540
+ 'is_access_code_error',
11541
+ 'error_code',
11542
+ ],
11543
+ type: 'object',
11544
+ },
11545
+ {
11546
+ description: 'Duplicate access code detected on device.',
11547
+ properties: {
11548
+ error_code: {
11549
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11550
+ enum: ['duplicate_code_on_device'],
11551
+ type: 'string',
11552
+ },
11553
+ is_access_code_error: { enum: [true], type: 'boolean' },
11554
+ message: { type: 'string' },
11555
+ },
11556
+ required: [
11557
+ 'message',
11558
+ 'is_access_code_error',
11559
+ 'error_code',
11560
+ ],
11561
+ type: 'object',
11562
+ },
11563
+ {
11564
+ description: 'An attempt to modify this access code was prevented.',
11565
+ properties: {
11566
+ error_code: {
11567
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11568
+ enum: ['duplicate_code_attempt_prevented'],
11569
+ type: 'string',
11570
+ },
11571
+ is_access_code_error: { enum: [true], type: 'boolean' },
11572
+ message: { type: 'string' },
11573
+ },
11574
+ required: [
11575
+ 'message',
11576
+ 'is_access_code_error',
11577
+ 'error_code',
11578
+ ],
11579
+ type: 'object',
11580
+ },
11581
+ {
11582
+ description: 'Igloohome bridge has too many pending jobs in the queue.',
11583
+ properties: {
11584
+ error_code: {
11585
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11586
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
11587
+ type: 'string',
11588
+ },
11589
+ is_access_code_error: { enum: [true], type: 'boolean' },
11590
+ message: { type: 'string' },
11591
+ },
11592
+ required: [
11593
+ 'message',
11594
+ 'is_access_code_error',
11595
+ 'error_code',
11596
+ ],
11597
+ type: 'object',
11598
+ },
11599
+ {
11600
+ description: 'Igloohome bridge is offline.',
11601
+ properties: {
11602
+ error_code: {
11603
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11604
+ enum: ['igloohome_bridge_offline'],
11605
+ type: 'string',
11606
+ },
11607
+ is_access_code_error: { enum: [true], type: 'boolean' },
11608
+ message: { type: 'string' },
11609
+ },
11610
+ required: [
11611
+ 'message',
11612
+ 'is_access_code_error',
11613
+ 'error_code',
11614
+ ],
11615
+ type: 'object',
11616
+ },
11617
+ {
11618
+ description: 'Lock as reached max amount of codes.',
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
+ 'igloohome_offline_access_code_no_variance_available',
11624
+ ],
11625
+ type: 'string',
11626
+ },
11627
+ is_access_code_error: { enum: [true], type: 'boolean' },
11628
+ message: { type: 'string' },
11629
+ },
11630
+ required: [
11631
+ 'message',
11632
+ 'is_access_code_error',
11633
+ 'error_code',
11634
+ ],
11635
+ type: 'object',
11636
+ },
11637
+ {
11638
+ description: 'Unable to confirm the access code is set on Kwikset device.',
11639
+ properties: {
11640
+ error_code: {
11641
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11642
+ enum: ['kwikset_unable_to_confirm_code'],
11643
+ type: 'string',
11644
+ },
11645
+ is_access_code_error: { enum: [true], type: 'boolean' },
11646
+ message: { type: 'string' },
11647
+ },
11648
+ required: [
11649
+ 'message',
11650
+ 'is_access_code_error',
11651
+ 'error_code',
11652
+ ],
11653
+ type: 'object',
11654
+ },
11655
+ {
11656
+ description: 'Unable to confirm the deletion of the access code on Kwikset device.',
11657
+ properties: {
11658
+ error_code: {
11659
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11660
+ enum: ['kwikset_unable_to_confirm_deletion'],
11661
+ type: 'string',
11662
+ },
11663
+ is_access_code_error: { enum: [true], type: 'boolean' },
11664
+ message: { type: 'string' },
11665
+ },
11666
+ required: [
11667
+ 'message',
11668
+ 'is_access_code_error',
11669
+ 'error_code',
11670
+ ],
11671
+ type: 'object',
11672
+ },
11673
+ {
11674
+ description: 'Code was modified or removed externally after Seam successfully set it on the device.',
11675
+ properties: {
11676
+ error_code: {
11677
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11678
+ enum: ['code_modified_external_to_seam'],
11679
+ type: 'string',
11680
+ },
11681
+ is_access_code_error: { enum: [true], type: 'boolean' },
11682
+ message: { type: 'string' },
11683
+ },
11684
+ required: [
11685
+ 'message',
11686
+ 'is_access_code_error',
11687
+ 'error_code',
11688
+ ],
11689
+ type: 'object',
11690
+ },
11691
+ {
11692
+ description: 'Invalid code length for August lock.',
11693
+ properties: {
11694
+ error_code: {
11695
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11696
+ enum: ['august_lock_invalid_code_length'],
11697
+ type: 'string',
11698
+ },
11699
+ is_access_code_error: { enum: [true], type: 'boolean' },
11700
+ message: { type: 'string' },
11701
+ },
11702
+ required: [
11703
+ 'message',
11704
+ 'is_access_code_error',
11705
+ 'error_code',
11706
+ ],
11707
+ type: 'object',
11708
+ },
11709
+ {
11710
+ description: 'Access code has not yet been fully moved to the device.',
11711
+ properties: {
11712
+ error_code: {
11713
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11714
+ enum: ['august_device_programming_delay'],
11715
+ type: 'string',
11716
+ },
11717
+ is_access_code_error: { enum: [true], type: 'boolean' },
11718
+ message: { type: 'string' },
11719
+ },
11720
+ required: [
11721
+ 'message',
11722
+ 'is_access_code_error',
11723
+ 'error_code',
11724
+ ],
11725
+ type: 'object',
11726
+ },
11727
+ {
11728
+ description: 'All access code slots on the device are full.',
11729
+ properties: {
11730
+ error_code: {
11731
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11732
+ enum: ['august_device_slots_full'],
11733
+ type: 'string',
11734
+ },
11735
+ is_access_code_error: { enum: [true], type: 'boolean' },
11736
+ message: { type: 'string' },
11737
+ },
11738
+ required: [
11739
+ 'message',
11740
+ 'is_access_code_error',
11741
+ 'error_code',
11742
+ ],
11743
+ type: 'object',
11744
+ },
11745
+ {
11746
+ description: 'August lock is missing a keypad.',
11747
+ properties: {
11748
+ error_code: {
11749
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11750
+ enum: ['august_lock_missing_keypad'],
11751
+ type: 'string',
11752
+ },
11753
+ is_access_code_error: { enum: [true], type: 'boolean' },
11754
+ message: { type: 'string' },
11755
+ },
11756
+ required: [
11757
+ 'message',
11758
+ 'is_access_code_error',
11759
+ 'error_code',
11760
+ ],
11761
+ type: 'object',
11762
+ },
11763
+ {
11764
+ description: 'Salto site user is not subscribed.',
11765
+ properties: {
11766
+ error_code: {
11767
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11768
+ enum: ['salto_site_user_not_subscribed'],
11769
+ type: 'string',
11770
+ },
11771
+ is_access_code_error: { enum: [true], type: 'boolean' },
11772
+ message: { type: 'string' },
11773
+ },
11774
+ required: [
11775
+ 'message',
11776
+ 'is_access_code_error',
11777
+ 'error_code',
11778
+ ],
11779
+ type: 'object',
11780
+ },
11781
+ {
11782
+ description: 'Access code has not yet been fully moved to the device.',
11783
+ properties: {
11784
+ error_code: {
11785
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11786
+ enum: ['hubitat_device_programming_delay'],
11787
+ type: 'string',
11788
+ },
11789
+ is_access_code_error: { enum: [true], type: 'boolean' },
11790
+ message: { type: 'string' },
11791
+ },
11792
+ required: [
11793
+ 'message',
11794
+ 'is_access_code_error',
11795
+ 'error_code',
11796
+ ],
11797
+ type: 'object',
11798
+ },
11799
+ {
11800
+ description: 'No free positions available on the device.',
11801
+ properties: {
11802
+ error_code: {
11803
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11804
+ enum: ['hubitat_no_free_positions_available'],
11805
+ type: 'string',
11806
+ },
11807
+ is_access_code_error: { enum: [true], type: 'boolean' },
11808
+ message: { type: 'string' },
11809
+ },
11810
+ required: [
11811
+ 'message',
11812
+ 'is_access_code_error',
11813
+ 'error_code',
11814
+ ],
11815
+ type: 'object',
11816
+ },
11817
+ ],
10878
11818
  },
10879
11819
  {
10880
11820
  description: 'Error associated with the `device`.',
@@ -11064,55 +12004,211 @@ export default {
11064
12004
  ],
11065
12005
  },
11066
12006
  {
12007
+ oneOf: [
12008
+ {
12009
+ description: 'Account is disconnected.',
12010
+ properties: {
12011
+ error_code: {
12012
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12013
+ enum: ['account_disconnected'],
12014
+ type: 'string',
12015
+ },
12016
+ is_connected_account_error: {
12017
+ enum: [true],
12018
+ type: 'boolean',
12019
+ },
12020
+ message: { type: 'string' },
12021
+ },
12022
+ required: [
12023
+ 'message',
12024
+ 'is_connected_account_error',
12025
+ 'error_code',
12026
+ ],
12027
+ type: 'object',
12028
+ },
12029
+ {
12030
+ description: 'Credentials provided were invalid.',
12031
+ properties: {
12032
+ error_code: {
12033
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12034
+ enum: ['invalid_credentials'],
12035
+ type: 'string',
12036
+ },
12037
+ is_connected_account_error: {
12038
+ enum: [true],
12039
+ type: 'boolean',
12040
+ },
12041
+ message: { type: 'string' },
12042
+ },
12043
+ required: [
12044
+ 'message',
12045
+ 'is_connected_account_error',
12046
+ 'error_code',
12047
+ ],
12048
+ type: 'object',
12049
+ },
12050
+ ],
12051
+ },
12052
+ ],
12053
+ },
12054
+ type: 'array',
12055
+ },
12056
+ is_managed: { enum: [false], type: 'boolean' },
12057
+ name: {
12058
+ description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
12059
+ nullable: true,
12060
+ type: 'string',
12061
+ },
12062
+ starts_at: {
12063
+ description: 'Date and time at which the time-bound access code becomes active.',
12064
+ format: 'date-time',
12065
+ nullable: true,
12066
+ type: 'string',
12067
+ },
12068
+ status: { enum: ['set'], type: 'string' },
12069
+ type: {
12070
+ 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.',
12071
+ enum: ['time_bound', 'ongoing'],
12072
+ type: 'string',
12073
+ },
12074
+ warnings: {
12075
+ 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.',
12076
+ items: {
12077
+ oneOf: [
12078
+ {
12079
+ description: 'Failed to set code on Smart Things device.',
11067
12080
  properties: {
11068
- error_code: { type: 'string' },
11069
- is_connected_account_error: {
11070
- enum: [true],
11071
- type: 'boolean',
12081
+ message: { type: 'string' },
12082
+ warning_code: {
12083
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12084
+ enum: ['smartthings_failed_to_set_access_code'],
12085
+ type: 'string',
12086
+ },
12087
+ },
12088
+ required: ['message', 'warning_code'],
12089
+ type: 'object',
12090
+ },
12091
+ {
12092
+ description: 'Duplicate access code detected.',
12093
+ properties: {
12094
+ message: { type: 'string' },
12095
+ warning_code: {
12096
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12097
+ enum: ['schlage_detected_duplicate'],
12098
+ type: 'string',
12099
+ },
12100
+ },
12101
+ required: ['message', 'warning_code'],
12102
+ type: 'object',
12103
+ },
12104
+ {
12105
+ description: 'Received an error when attempting to create this code.',
12106
+ properties: {
12107
+ message: { type: 'string' },
12108
+ warning_code: {
12109
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12110
+ enum: ['schlage_creation_outage'],
12111
+ type: 'string',
12112
+ },
12113
+ },
12114
+ required: ['message', 'warning_code'],
12115
+ type: 'object',
12116
+ },
12117
+ {
12118
+ description: 'Code was modified or removed externally after Seam successfully set it on the device.',
12119
+ properties: {
12120
+ message: { type: 'string' },
12121
+ warning_code: {
12122
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12123
+ enum: ['code_modified_external_to_seam'],
12124
+ type: 'string',
12125
+ },
12126
+ },
12127
+ required: ['message', 'warning_code'],
12128
+ type: 'object',
12129
+ },
12130
+ {
12131
+ description: 'Delay in setting code on device.',
12132
+ properties: {
12133
+ message: { type: 'string' },
12134
+ warning_code: {
12135
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12136
+ enum: ['delay_in_setting_on_device'],
12137
+ type: 'string',
12138
+ },
12139
+ },
12140
+ required: ['message', 'warning_code'],
12141
+ type: 'object',
12142
+ },
12143
+ {
12144
+ description: 'Delay in removing code from device.',
12145
+ properties: {
12146
+ message: { type: 'string' },
12147
+ warning_code: {
12148
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12149
+ enum: ['delay_in_removing_from_device'],
12150
+ type: 'string',
12151
+ },
12152
+ },
12153
+ required: ['message', 'warning_code'],
12154
+ type: 'object',
12155
+ },
12156
+ {
12157
+ description: 'Third party integration detected that may cause access codes to fail.',
12158
+ properties: {
12159
+ message: { type: 'string' },
12160
+ warning_code: {
12161
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12162
+ enum: ['third_party_integration_detected'],
12163
+ type: 'string',
12164
+ },
12165
+ },
12166
+ required: ['message', 'warning_code'],
12167
+ type: 'object',
12168
+ },
12169
+ {
12170
+ description: 'Access code has not yet been fully moved to the device.',
12171
+ properties: {
12172
+ message: { type: 'string' },
12173
+ warning_code: {
12174
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12175
+ enum: ['august_device_programming_delay'],
12176
+ type: 'string',
12177
+ },
12178
+ },
12179
+ required: ['message', 'warning_code'],
12180
+ type: 'object',
12181
+ },
12182
+ {
12183
+ description: 'Algopins must be used within 24 hours.',
12184
+ properties: {
12185
+ message: { type: 'string' },
12186
+ warning_code: {
12187
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12188
+ enum: ['igloo_algopin_must_be_used_within_24_hours'],
12189
+ type: 'string',
11072
12190
  },
12191
+ },
12192
+ required: ['message', 'warning_code'],
12193
+ type: 'object',
12194
+ },
12195
+ {
12196
+ description: 'Management was transferred to another workspace.',
12197
+ properties: {
11073
12198
  message: { type: 'string' },
12199
+ warning_code: {
12200
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12201
+ enum: ['management_transferred'],
12202
+ type: 'string',
12203
+ },
11074
12204
  },
11075
- required: [
11076
- 'message',
11077
- 'is_connected_account_error',
11078
- 'error_code',
11079
- ],
12205
+ required: ['message', 'warning_code'],
11080
12206
  type: 'object',
11081
12207
  },
11082
12208
  ],
11083
12209
  },
11084
12210
  type: 'array',
11085
12211
  },
11086
- is_managed: { enum: [false], type: 'boolean' },
11087
- name: {
11088
- description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
11089
- nullable: true,
11090
- type: 'string',
11091
- },
11092
- starts_at: {
11093
- description: 'Date and time at which the time-bound access code becomes active.',
11094
- format: 'date-time',
11095
- nullable: true,
11096
- type: 'string',
11097
- },
11098
- status: { enum: ['set'], type: 'string' },
11099
- type: {
11100
- 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.',
11101
- enum: ['time_bound', 'ongoing'],
11102
- type: 'string',
11103
- },
11104
- warnings: {
11105
- 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.',
11106
- items: {
11107
- properties: {
11108
- message: { type: 'string' },
11109
- warning_code: { type: 'string' },
11110
- },
11111
- required: ['message', 'warning_code'],
11112
- type: 'object',
11113
- },
11114
- type: 'array',
11115
- },
11116
12212
  },
11117
12213
  required: [
11118
12214
  'type',
@@ -11415,20 +12511,50 @@ export default {
11415
12511
  ],
11416
12512
  },
11417
12513
  {
11418
- properties: {
11419
- error_code: { type: 'string' },
11420
- is_connected_account_error: {
11421
- enum: [true],
11422
- type: 'boolean',
12514
+ oneOf: [
12515
+ {
12516
+ description: 'Account is disconnected.',
12517
+ properties: {
12518
+ error_code: {
12519
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12520
+ enum: ['account_disconnected'],
12521
+ type: 'string',
12522
+ },
12523
+ is_connected_account_error: {
12524
+ enum: [true],
12525
+ type: 'boolean',
12526
+ },
12527
+ message: { type: 'string' },
12528
+ },
12529
+ required: [
12530
+ 'message',
12531
+ 'is_connected_account_error',
12532
+ 'error_code',
12533
+ ],
12534
+ type: 'object',
12535
+ },
12536
+ {
12537
+ description: 'Credentials provided were invalid.',
12538
+ properties: {
12539
+ error_code: {
12540
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12541
+ enum: ['invalid_credentials'],
12542
+ type: 'string',
12543
+ },
12544
+ is_connected_account_error: {
12545
+ enum: [true],
12546
+ type: 'boolean',
12547
+ },
12548
+ message: { type: 'string' },
12549
+ },
12550
+ required: [
12551
+ 'message',
12552
+ 'is_connected_account_error',
12553
+ 'error_code',
12554
+ ],
12555
+ type: 'object',
11423
12556
  },
11424
- message: { type: 'string' },
11425
- },
11426
- required: [
11427
- 'message',
11428
- 'is_connected_account_error',
11429
- 'error_code',
11430
12557
  ],
11431
- type: 'object',
11432
12558
  },
11433
12559
  ],
11434
12560
  },
@@ -20515,160 +21641,160 @@ export default {
20515
21641
  },
20516
21642
  event_type: {
20517
21643
  enum: [
20518
- 'device.accessory_keypad_connected',
20519
- 'device.accessory_keypad_disconnected',
20520
- 'device.added',
20521
- 'device.connected',
20522
- 'device.unmanaged.connected',
20523
- 'device.disconnected',
20524
- 'device.unmanaged.disconnected',
20525
- 'device.converted_to_unmanaged',
20526
- 'device.unmanaged.converted_to_managed',
20527
- 'device.removed',
20528
- 'device.deleted',
20529
- 'device.tampered',
20530
- 'device.low_battery',
20531
- 'device.battery_status_changed',
20532
- 'device.third_party_integration_detected',
20533
- 'device.third_party_integration_no_longer_detected',
20534
- 'device.salto.privacy_mode_activated',
20535
- 'device.salto.privacy_mode_deactivated',
20536
- 'device.connection_became_flaky',
20537
- 'device.connection_stabilized',
20538
- 'device.error.subscription_required',
20539
- 'device.error.subscription_required.resolved',
20540
21644
  'access_code.created',
20541
21645
  'access_code.changed',
20542
21646
  'access_code.scheduled_on_device',
20543
21647
  'access_code.set_on_device',
20544
- 'access_code.deleted',
20545
21648
  'access_code.removed_from_device',
20546
- 'access_code.failed_to_set_on_device',
20547
21649
  'access_code.delay_in_setting_on_device',
20548
- 'access_code.failed_to_remove_from_device',
21650
+ 'access_code.failed_to_set_on_device',
21651
+ 'access_code.deleted',
20549
21652
  'access_code.delay_in_removing_from_device',
20550
- 'access_code.deleted_external_to_seam',
21653
+ 'access_code.failed_to_remove_from_device',
20551
21654
  'access_code.modified_external_to_seam',
21655
+ 'access_code.deleted_external_to_seam',
21656
+ 'access_code.backup_access_code_pulled',
20552
21657
  'access_code.unmanaged.converted_to_managed',
20553
21658
  'access_code.unmanaged.failed_to_convert_to_managed',
20554
21659
  'access_code.unmanaged.created',
20555
21660
  'access_code.unmanaged.removed',
20556
- 'lock.locked',
20557
- 'lock.unlocked',
20558
- 'lock.access_denied',
20559
- 'phone.deactivated',
20560
- 'connected_account.connected',
20561
- 'connected_account.successful_login',
20562
- 'connected_account.created',
20563
- 'connected_account.deleted',
20564
- 'connected_account.disconnected',
20565
- 'connected_account.completed_first_sync',
20566
- 'connected_account.completed_first_sync_after_reconnection',
20567
- 'connect_webview.login_succeeded',
20568
- 'connect_webview.login_failed',
20569
- 'noise_sensor.noise_threshold_triggered',
20570
- 'access_code.backup_access_code_pulled',
20571
- 'acs_system.added',
20572
21661
  'acs_system.connected',
21662
+ 'acs_system.added',
20573
21663
  'acs_system.disconnected',
20574
- 'acs_access_group.deleted',
20575
- 'acs_user.deleted',
20576
21664
  'acs_credential.deleted',
20577
21665
  'acs_credential.issued',
20578
21666
  'acs_credential.reissued',
21667
+ 'acs_user.deleted',
20579
21668
  'acs_encoder.added',
20580
21669
  'acs_encoder.removed',
20581
- 'enrollment_automation.deleted',
21670
+ 'acs_access_group.deleted',
20582
21671
  'client_session.deleted',
21672
+ 'connected_account.connected',
21673
+ 'connected_account.created',
21674
+ 'connected_account.successful_login',
21675
+ 'connected_account.disconnected',
21676
+ 'connected_account.completed_first_sync',
21677
+ 'connected_account.deleted',
21678
+ 'connected_account.completed_first_sync_after_reconnection',
20583
21679
  'action_attempt.lock_door.succeeded',
20584
21680
  'action_attempt.lock_door.failed',
20585
21681
  'action_attempt.unlock_door.succeeded',
20586
21682
  'action_attempt.unlock_door.failed',
21683
+ 'connect_webview.login_succeeded',
21684
+ 'connect_webview.login_failed',
21685
+ 'device.connected',
21686
+ 'device.added',
21687
+ 'device.converted_to_unmanaged',
21688
+ 'device.unmanaged.converted_to_managed',
21689
+ 'device.unmanaged.connected',
21690
+ 'device.disconnected',
21691
+ 'device.unmanaged.disconnected',
21692
+ 'device.tampered',
21693
+ 'device.low_battery',
21694
+ 'device.battery_status_changed',
21695
+ 'device.removed',
21696
+ 'device.deleted',
21697
+ 'device.third_party_integration_detected',
21698
+ 'device.third_party_integration_no_longer_detected',
21699
+ 'device.salto.privacy_mode_activated',
21700
+ 'device.salto.privacy_mode_deactivated',
21701
+ 'device.connection_became_flaky',
21702
+ 'device.connection_stabilized',
21703
+ 'device.error.subscription_required',
21704
+ 'device.error.subscription_required.resolved',
21705
+ 'device.accessory_keypad_connected',
21706
+ 'device.accessory_keypad_disconnected',
21707
+ 'noise_sensor.noise_threshold_triggered',
21708
+ 'lock.locked',
21709
+ 'lock.unlocked',
21710
+ 'lock.access_denied',
20587
21711
  'thermostat.climate_preset_activated',
20588
21712
  'thermostat.manually_adjusted',
20589
21713
  'thermostat.temperature_threshold_exceeded',
20590
21714
  'thermostat.temperature_threshold_no_longer_exceeded',
20591
21715
  'thermostat.temperature_reached_set_point',
21716
+ 'enrollment_automation.deleted',
21717
+ 'phone.deactivated',
20592
21718
  ],
20593
21719
  type: 'string',
20594
21720
  },
20595
21721
  event_types: {
20596
21722
  items: {
20597
21723
  enum: [
20598
- 'device.accessory_keypad_connected',
20599
- 'device.accessory_keypad_disconnected',
20600
- 'device.added',
20601
- 'device.connected',
20602
- 'device.unmanaged.connected',
20603
- 'device.disconnected',
20604
- 'device.unmanaged.disconnected',
20605
- 'device.converted_to_unmanaged',
20606
- 'device.unmanaged.converted_to_managed',
20607
- 'device.removed',
20608
- 'device.deleted',
20609
- 'device.tampered',
20610
- 'device.low_battery',
20611
- 'device.battery_status_changed',
20612
- 'device.third_party_integration_detected',
20613
- 'device.third_party_integration_no_longer_detected',
20614
- 'device.salto.privacy_mode_activated',
20615
- 'device.salto.privacy_mode_deactivated',
20616
- 'device.connection_became_flaky',
20617
- 'device.connection_stabilized',
20618
- 'device.error.subscription_required',
20619
- 'device.error.subscription_required.resolved',
20620
21724
  'access_code.created',
20621
21725
  'access_code.changed',
20622
21726
  'access_code.scheduled_on_device',
20623
21727
  'access_code.set_on_device',
20624
- 'access_code.deleted',
20625
21728
  'access_code.removed_from_device',
20626
- 'access_code.failed_to_set_on_device',
20627
21729
  'access_code.delay_in_setting_on_device',
20628
- 'access_code.failed_to_remove_from_device',
21730
+ 'access_code.failed_to_set_on_device',
21731
+ 'access_code.deleted',
20629
21732
  'access_code.delay_in_removing_from_device',
20630
- 'access_code.deleted_external_to_seam',
21733
+ 'access_code.failed_to_remove_from_device',
20631
21734
  'access_code.modified_external_to_seam',
21735
+ 'access_code.deleted_external_to_seam',
21736
+ 'access_code.backup_access_code_pulled',
20632
21737
  'access_code.unmanaged.converted_to_managed',
20633
21738
  'access_code.unmanaged.failed_to_convert_to_managed',
20634
21739
  'access_code.unmanaged.created',
20635
21740
  'access_code.unmanaged.removed',
20636
- 'lock.locked',
20637
- 'lock.unlocked',
20638
- 'lock.access_denied',
20639
- 'phone.deactivated',
20640
- 'connected_account.connected',
20641
- 'connected_account.successful_login',
20642
- 'connected_account.created',
20643
- 'connected_account.deleted',
20644
- 'connected_account.disconnected',
20645
- 'connected_account.completed_first_sync',
20646
- 'connected_account.completed_first_sync_after_reconnection',
20647
- 'connect_webview.login_succeeded',
20648
- 'connect_webview.login_failed',
20649
- 'noise_sensor.noise_threshold_triggered',
20650
- 'access_code.backup_access_code_pulled',
20651
- 'acs_system.added',
20652
21741
  'acs_system.connected',
21742
+ 'acs_system.added',
20653
21743
  'acs_system.disconnected',
20654
- 'acs_access_group.deleted',
20655
- 'acs_user.deleted',
20656
21744
  'acs_credential.deleted',
20657
21745
  'acs_credential.issued',
20658
21746
  'acs_credential.reissued',
21747
+ 'acs_user.deleted',
20659
21748
  'acs_encoder.added',
20660
21749
  'acs_encoder.removed',
20661
- 'enrollment_automation.deleted',
21750
+ 'acs_access_group.deleted',
20662
21751
  'client_session.deleted',
21752
+ 'connected_account.connected',
21753
+ 'connected_account.created',
21754
+ 'connected_account.successful_login',
21755
+ 'connected_account.disconnected',
21756
+ 'connected_account.completed_first_sync',
21757
+ 'connected_account.deleted',
21758
+ 'connected_account.completed_first_sync_after_reconnection',
20663
21759
  'action_attempt.lock_door.succeeded',
20664
21760
  'action_attempt.lock_door.failed',
20665
21761
  'action_attempt.unlock_door.succeeded',
20666
21762
  'action_attempt.unlock_door.failed',
21763
+ 'connect_webview.login_succeeded',
21764
+ 'connect_webview.login_failed',
21765
+ 'device.connected',
21766
+ 'device.added',
21767
+ 'device.converted_to_unmanaged',
21768
+ 'device.unmanaged.converted_to_managed',
21769
+ 'device.unmanaged.connected',
21770
+ 'device.disconnected',
21771
+ 'device.unmanaged.disconnected',
21772
+ 'device.tampered',
21773
+ 'device.low_battery',
21774
+ 'device.battery_status_changed',
21775
+ 'device.removed',
21776
+ 'device.deleted',
21777
+ 'device.third_party_integration_detected',
21778
+ 'device.third_party_integration_no_longer_detected',
21779
+ 'device.salto.privacy_mode_activated',
21780
+ 'device.salto.privacy_mode_deactivated',
21781
+ 'device.connection_became_flaky',
21782
+ 'device.connection_stabilized',
21783
+ 'device.error.subscription_required',
21784
+ 'device.error.subscription_required.resolved',
21785
+ 'device.accessory_keypad_connected',
21786
+ 'device.accessory_keypad_disconnected',
21787
+ 'noise_sensor.noise_threshold_triggered',
21788
+ 'lock.locked',
21789
+ 'lock.unlocked',
21790
+ 'lock.access_denied',
20667
21791
  'thermostat.climate_preset_activated',
20668
21792
  'thermostat.manually_adjusted',
20669
21793
  'thermostat.temperature_threshold_exceeded',
20670
21794
  'thermostat.temperature_threshold_no_longer_exceeded',
20671
21795
  'thermostat.temperature_reached_set_point',
21796
+ 'enrollment_automation.deleted',
21797
+ 'phone.deactivated',
20672
21798
  ],
20673
21799
  type: 'string',
20674
21800
  },