@seamapi/types 1.332.1 → 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.
@@ -44,13 +44,381 @@ export default {
44
44
  items: {
45
45
  oneOf: [
46
46
  {
47
- properties: {
48
- error_code: { type: 'string' },
49
- is_access_code_error: { enum: [true], type: 'boolean' },
50
- message: { type: 'string' },
51
- },
52
- required: ['message', 'is_access_code_error', 'error_code'],
53
- type: 'object',
47
+ oneOf: [
48
+ {
49
+ description: 'Failed to set code on Smart Things device.',
50
+ properties: {
51
+ error_code: {
52
+ description:
53
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
54
+ enum: ['smartthings_failed_to_set_access_code'],
55
+ type: 'string',
56
+ },
57
+ is_access_code_error: { enum: [true], type: 'boolean' },
58
+ message: { type: 'string' },
59
+ },
60
+ required: [
61
+ 'message',
62
+ 'is_access_code_error',
63
+ 'error_code',
64
+ ],
65
+ type: 'object',
66
+ },
67
+ {
68
+ description: 'Failed to set code after multiple retries.',
69
+ properties: {
70
+ error_code: {
71
+ description:
72
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
73
+ enum: [
74
+ 'smartthings_failed_to_set_after_multiple_retries',
75
+ ],
76
+ type: 'string',
77
+ },
78
+ is_access_code_error: { enum: [true], type: 'boolean' },
79
+ message: { type: 'string' },
80
+ },
81
+ required: [
82
+ 'message',
83
+ 'is_access_code_error',
84
+ 'error_code',
85
+ ],
86
+ type: 'object',
87
+ },
88
+ {
89
+ description: 'Failed to set code on device.',
90
+ properties: {
91
+ error_code: {
92
+ description:
93
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
94
+ enum: ['failed_to_set_on_device'],
95
+ type: 'string',
96
+ },
97
+ is_access_code_error: { enum: [true], type: 'boolean' },
98
+ message: { type: 'string' },
99
+ },
100
+ required: [
101
+ 'message',
102
+ 'is_access_code_error',
103
+ 'error_code',
104
+ ],
105
+ type: 'object',
106
+ },
107
+ {
108
+ description: 'Failed to remove code from device.',
109
+ properties: {
110
+ error_code: {
111
+ description:
112
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
113
+ enum: ['failed_to_remove_from_device'],
114
+ type: 'string',
115
+ },
116
+ is_access_code_error: { enum: [true], type: 'boolean' },
117
+ message: { type: 'string' },
118
+ },
119
+ required: [
120
+ 'message',
121
+ 'is_access_code_error',
122
+ 'error_code',
123
+ ],
124
+ type: 'object',
125
+ },
126
+ {
127
+ description: 'Duplicate access code detected on device.',
128
+ properties: {
129
+ error_code: {
130
+ description:
131
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
132
+ enum: ['duplicate_code_on_device'],
133
+ type: 'string',
134
+ },
135
+ is_access_code_error: { enum: [true], type: 'boolean' },
136
+ message: { type: 'string' },
137
+ },
138
+ required: [
139
+ 'message',
140
+ 'is_access_code_error',
141
+ 'error_code',
142
+ ],
143
+ type: 'object',
144
+ },
145
+ {
146
+ description:
147
+ 'An attempt to modify this access code was prevented.',
148
+ properties: {
149
+ error_code: {
150
+ description:
151
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
152
+ enum: ['duplicate_code_attempt_prevented'],
153
+ type: 'string',
154
+ },
155
+ is_access_code_error: { enum: [true], type: 'boolean' },
156
+ message: { type: 'string' },
157
+ },
158
+ required: [
159
+ 'message',
160
+ 'is_access_code_error',
161
+ 'error_code',
162
+ ],
163
+ type: 'object',
164
+ },
165
+ {
166
+ description:
167
+ 'Igloohome bridge has too many pending jobs in the queue.',
168
+ properties: {
169
+ error_code: {
170
+ description:
171
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
172
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
173
+ type: 'string',
174
+ },
175
+ is_access_code_error: { enum: [true], type: 'boolean' },
176
+ message: { type: 'string' },
177
+ },
178
+ required: [
179
+ 'message',
180
+ 'is_access_code_error',
181
+ 'error_code',
182
+ ],
183
+ type: 'object',
184
+ },
185
+ {
186
+ description: 'Igloohome bridge is offline.',
187
+ properties: {
188
+ error_code: {
189
+ description:
190
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
191
+ enum: ['igloohome_bridge_offline'],
192
+ type: 'string',
193
+ },
194
+ is_access_code_error: { enum: [true], type: 'boolean' },
195
+ message: { type: 'string' },
196
+ },
197
+ required: [
198
+ 'message',
199
+ 'is_access_code_error',
200
+ 'error_code',
201
+ ],
202
+ type: 'object',
203
+ },
204
+ {
205
+ description: 'Lock as reached max amount of codes.',
206
+ properties: {
207
+ error_code: {
208
+ description:
209
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
210
+ enum: [
211
+ 'igloohome_offline_access_code_no_variance_available',
212
+ ],
213
+ type: 'string',
214
+ },
215
+ is_access_code_error: { enum: [true], type: 'boolean' },
216
+ message: { type: 'string' },
217
+ },
218
+ required: [
219
+ 'message',
220
+ 'is_access_code_error',
221
+ 'error_code',
222
+ ],
223
+ type: 'object',
224
+ },
225
+ {
226
+ description:
227
+ 'Unable to confirm the access code is set on Kwikset device.',
228
+ properties: {
229
+ error_code: {
230
+ description:
231
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
232
+ enum: ['kwikset_unable_to_confirm_code'],
233
+ type: 'string',
234
+ },
235
+ is_access_code_error: { enum: [true], type: 'boolean' },
236
+ message: { type: 'string' },
237
+ },
238
+ required: [
239
+ 'message',
240
+ 'is_access_code_error',
241
+ 'error_code',
242
+ ],
243
+ type: 'object',
244
+ },
245
+ {
246
+ description:
247
+ 'Unable to confirm the deletion of the access code on Kwikset device.',
248
+ properties: {
249
+ error_code: {
250
+ description:
251
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
252
+ enum: ['kwikset_unable_to_confirm_deletion'],
253
+ type: 'string',
254
+ },
255
+ is_access_code_error: { enum: [true], type: 'boolean' },
256
+ message: { type: 'string' },
257
+ },
258
+ required: [
259
+ 'message',
260
+ 'is_access_code_error',
261
+ 'error_code',
262
+ ],
263
+ type: 'object',
264
+ },
265
+ {
266
+ description:
267
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
268
+ properties: {
269
+ error_code: {
270
+ description:
271
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
272
+ enum: ['code_modified_external_to_seam'],
273
+ type: 'string',
274
+ },
275
+ is_access_code_error: { enum: [true], type: 'boolean' },
276
+ message: { type: 'string' },
277
+ },
278
+ required: [
279
+ 'message',
280
+ 'is_access_code_error',
281
+ 'error_code',
282
+ ],
283
+ type: 'object',
284
+ },
285
+ {
286
+ description: 'Invalid code length for August lock.',
287
+ properties: {
288
+ error_code: {
289
+ description:
290
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
291
+ enum: ['august_lock_invalid_code_length'],
292
+ type: 'string',
293
+ },
294
+ is_access_code_error: { enum: [true], type: 'boolean' },
295
+ message: { type: 'string' },
296
+ },
297
+ required: [
298
+ 'message',
299
+ 'is_access_code_error',
300
+ 'error_code',
301
+ ],
302
+ type: 'object',
303
+ },
304
+ {
305
+ description:
306
+ 'Access code has not yet been fully moved to the device.',
307
+ properties: {
308
+ error_code: {
309
+ description:
310
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
311
+ enum: ['august_device_programming_delay'],
312
+ type: 'string',
313
+ },
314
+ is_access_code_error: { enum: [true], type: 'boolean' },
315
+ message: { type: 'string' },
316
+ },
317
+ required: [
318
+ 'message',
319
+ 'is_access_code_error',
320
+ 'error_code',
321
+ ],
322
+ type: 'object',
323
+ },
324
+ {
325
+ description:
326
+ 'All access code slots on the device are full.',
327
+ properties: {
328
+ error_code: {
329
+ description:
330
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
331
+ enum: ['august_device_slots_full'],
332
+ type: 'string',
333
+ },
334
+ is_access_code_error: { enum: [true], type: 'boolean' },
335
+ message: { type: 'string' },
336
+ },
337
+ required: [
338
+ 'message',
339
+ 'is_access_code_error',
340
+ 'error_code',
341
+ ],
342
+ type: 'object',
343
+ },
344
+ {
345
+ description: 'August lock is missing a keypad.',
346
+ properties: {
347
+ error_code: {
348
+ description:
349
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
350
+ enum: ['august_lock_missing_keypad'],
351
+ type: 'string',
352
+ },
353
+ is_access_code_error: { enum: [true], type: 'boolean' },
354
+ message: { type: 'string' },
355
+ },
356
+ required: [
357
+ 'message',
358
+ 'is_access_code_error',
359
+ 'error_code',
360
+ ],
361
+ type: 'object',
362
+ },
363
+ {
364
+ description: 'Salto site user is not subscribed.',
365
+ properties: {
366
+ error_code: {
367
+ description:
368
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
369
+ enum: ['salto_site_user_not_subscribed'],
370
+ type: 'string',
371
+ },
372
+ is_access_code_error: { enum: [true], type: 'boolean' },
373
+ message: { type: 'string' },
374
+ },
375
+ required: [
376
+ 'message',
377
+ 'is_access_code_error',
378
+ 'error_code',
379
+ ],
380
+ type: 'object',
381
+ },
382
+ {
383
+ description:
384
+ 'Access code has not yet been fully moved to the device.',
385
+ properties: {
386
+ error_code: {
387
+ description:
388
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
389
+ enum: ['hubitat_device_programming_delay'],
390
+ type: 'string',
391
+ },
392
+ is_access_code_error: { enum: [true], type: 'boolean' },
393
+ message: { type: 'string' },
394
+ },
395
+ required: [
396
+ 'message',
397
+ 'is_access_code_error',
398
+ 'error_code',
399
+ ],
400
+ type: 'object',
401
+ },
402
+ {
403
+ description: 'No free positions available on the device.',
404
+ properties: {
405
+ error_code: {
406
+ description:
407
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
408
+ enum: ['hubitat_no_free_positions_available'],
409
+ type: 'string',
410
+ },
411
+ is_access_code_error: { enum: [true], type: 'boolean' },
412
+ message: { type: 'string' },
413
+ },
414
+ required: [
415
+ 'message',
416
+ 'is_access_code_error',
417
+ 'error_code',
418
+ ],
419
+ type: 'object',
420
+ },
421
+ ],
54
422
  },
55
423
  {
56
424
  description: 'Error associated with the `device`.',
@@ -251,112 +619,285 @@ export default {
251
619
  required: ['message', 'is_device_error', 'error_code'],
252
620
  type: 'object',
253
621
  },
254
- ],
622
+ ],
623
+ },
624
+ {
625
+ oneOf: [
626
+ {
627
+ description: 'Account is disconnected.',
628
+ properties: {
629
+ error_code: {
630
+ description:
631
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
632
+ enum: ['account_disconnected'],
633
+ type: 'string',
634
+ },
635
+ is_connected_account_error: {
636
+ enum: [true],
637
+ type: 'boolean',
638
+ },
639
+ message: { type: 'string' },
640
+ },
641
+ required: [
642
+ 'message',
643
+ 'is_connected_account_error',
644
+ 'error_code',
645
+ ],
646
+ type: 'object',
647
+ },
648
+ {
649
+ description: 'Credentials provided were invalid.',
650
+ properties: {
651
+ error_code: {
652
+ description:
653
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
654
+ enum: ['invalid_credentials'],
655
+ type: 'string',
656
+ },
657
+ is_connected_account_error: {
658
+ enum: [true],
659
+ type: 'boolean',
660
+ },
661
+ message: { type: 'string' },
662
+ },
663
+ required: [
664
+ 'message',
665
+ 'is_connected_account_error',
666
+ 'error_code',
667
+ ],
668
+ type: 'object',
669
+ },
670
+ ],
671
+ },
672
+ ],
673
+ },
674
+ type: 'array',
675
+ },
676
+ is_backup: {
677
+ description: 'Indicates whether the access code is a backup code.',
678
+ type: 'boolean',
679
+ },
680
+ is_backup_access_code_available: {
681
+ description:
682
+ 'Indicates whether a backup access code is available for use if the primary access code is lost or compromised.',
683
+ type: 'boolean',
684
+ },
685
+ is_external_modification_allowed: {
686
+ description:
687
+ 'Indicates whether changes to the access code from external sources are permitted.',
688
+ type: 'boolean',
689
+ },
690
+ is_managed: {
691
+ description: 'Indicates whether Seam manages the access code.',
692
+ enum: [true],
693
+ type: 'boolean',
694
+ },
695
+ is_offline_access_code: {
696
+ description:
697
+ '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.',
698
+ type: 'boolean',
699
+ },
700
+ is_one_time_use: {
701
+ description:
702
+ 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
703
+ type: 'boolean',
704
+ },
705
+ is_scheduled_on_device: {
706
+ description:
707
+ 'Indicates whether the code is set on the device according to a preconfigured schedule.',
708
+ type: 'boolean',
709
+ },
710
+ is_waiting_for_code_assignment: {
711
+ description:
712
+ 'Indicates whether the access code is waiting for a code assignment.',
713
+ type: 'boolean',
714
+ },
715
+ name: {
716
+ description:
717
+ 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
718
+ nullable: true,
719
+ type: 'string',
720
+ },
721
+ pulled_backup_access_code_id: {
722
+ description:
723
+ 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.',
724
+ format: 'uuid',
725
+ nullable: true,
726
+ type: 'string',
727
+ },
728
+ starts_at: {
729
+ description:
730
+ 'Date and time at which the time-bound access code becomes active.',
731
+ format: 'date-time',
732
+ nullable: true,
733
+ type: 'string',
734
+ },
735
+ status: {
736
+ description:
737
+ '\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 ',
738
+ enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
739
+ type: 'string',
740
+ },
741
+ type: {
742
+ description:
743
+ '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.',
744
+ enum: ['time_bound', 'ongoing'],
745
+ type: 'string',
746
+ },
747
+ warnings: {
748
+ description:
749
+ 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
750
+ items: {
751
+ oneOf: [
752
+ {
753
+ description: 'Failed to set code on Smart Things device.',
754
+ properties: {
755
+ message: { type: 'string' },
756
+ warning_code: {
757
+ description:
758
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
759
+ enum: ['smartthings_failed_to_set_access_code'],
760
+ type: 'string',
761
+ },
762
+ },
763
+ required: ['message', 'warning_code'],
764
+ type: 'object',
765
+ },
766
+ {
767
+ description: 'Duplicate access code detected.',
768
+ properties: {
769
+ message: { type: 'string' },
770
+ warning_code: {
771
+ description:
772
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
773
+ enum: ['schlage_detected_duplicate'],
774
+ type: 'string',
775
+ },
776
+ },
777
+ required: ['message', 'warning_code'],
778
+ type: 'object',
779
+ },
780
+ {
781
+ description:
782
+ 'Received an error when attempting to create this code.',
783
+ properties: {
784
+ message: { type: 'string' },
785
+ warning_code: {
786
+ description:
787
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
788
+ enum: ['schlage_creation_outage'],
789
+ type: 'string',
790
+ },
791
+ },
792
+ required: ['message', 'warning_code'],
793
+ type: 'object',
794
+ },
795
+ {
796
+ description:
797
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
798
+ properties: {
799
+ message: { type: 'string' },
800
+ warning_code: {
801
+ description:
802
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
803
+ enum: ['code_modified_external_to_seam'],
804
+ type: 'string',
805
+ },
806
+ },
807
+ required: ['message', 'warning_code'],
808
+ type: 'object',
809
+ },
810
+ {
811
+ description: 'Delay in setting code on device.',
812
+ properties: {
813
+ message: { type: 'string' },
814
+ warning_code: {
815
+ description:
816
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
817
+ enum: ['delay_in_setting_on_device'],
818
+ type: 'string',
819
+ },
820
+ },
821
+ required: ['message', 'warning_code'],
822
+ type: 'object',
823
+ },
824
+ {
825
+ description: 'Delay in removing code from device.',
826
+ properties: {
827
+ message: { type: 'string' },
828
+ warning_code: {
829
+ description:
830
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
831
+ enum: ['delay_in_removing_from_device'],
832
+ type: 'string',
833
+ },
834
+ },
835
+ required: ['message', 'warning_code'],
836
+ type: 'object',
837
+ },
838
+ {
839
+ description:
840
+ 'Third party integration detected that may cause access codes to fail.',
841
+ properties: {
842
+ message: { type: 'string' },
843
+ warning_code: {
844
+ description:
845
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
846
+ enum: ['third_party_integration_detected'],
847
+ type: 'string',
848
+ },
849
+ },
850
+ required: ['message', 'warning_code'],
851
+ type: 'object',
255
852
  },
256
853
  {
854
+ description:
855
+ 'Access code has not yet been fully moved to the device.',
257
856
  properties: {
258
- error_code: { type: 'string' },
259
- is_connected_account_error: {
260
- enum: [true],
261
- type: 'boolean',
857
+ message: { type: 'string' },
858
+ warning_code: {
859
+ description:
860
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
861
+ enum: ['august_device_programming_delay'],
862
+ type: 'string',
262
863
  },
864
+ },
865
+ required: ['message', 'warning_code'],
866
+ type: 'object',
867
+ },
868
+ {
869
+ description: 'Algopins must be used within 24 hours.',
870
+ properties: {
263
871
  message: { type: 'string' },
872
+ warning_code: {
873
+ description:
874
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
875
+ enum: ['igloo_algopin_must_be_used_within_24_hours'],
876
+ type: 'string',
877
+ },
264
878
  },
265
- required: [
266
- 'message',
267
- 'is_connected_account_error',
268
- 'error_code',
269
- ],
879
+ required: ['message', 'warning_code'],
880
+ type: 'object',
881
+ },
882
+ {
883
+ description:
884
+ 'Management was transferred to another workspace.',
885
+ properties: {
886
+ message: { type: 'string' },
887
+ warning_code: {
888
+ description:
889
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
890
+ enum: ['management_transferred'],
891
+ type: 'string',
892
+ },
893
+ },
894
+ required: ['message', 'warning_code'],
270
895
  type: 'object',
271
896
  },
272
897
  ],
273
898
  },
274
899
  type: 'array',
275
900
  },
276
- is_backup: {
277
- description: 'Indicates whether the access code is a backup code.',
278
- type: 'boolean',
279
- },
280
- is_backup_access_code_available: {
281
- description:
282
- 'Indicates whether a backup access code is available for use if the primary access code is lost or compromised.',
283
- type: 'boolean',
284
- },
285
- is_external_modification_allowed: {
286
- description:
287
- 'Indicates whether changes to the access code from external sources are permitted.',
288
- type: 'boolean',
289
- },
290
- is_managed: {
291
- description: 'Indicates whether Seam manages the access code.',
292
- enum: [true],
293
- type: 'boolean',
294
- },
295
- is_offline_access_code: {
296
- description:
297
- '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.',
298
- type: 'boolean',
299
- },
300
- is_one_time_use: {
301
- description:
302
- 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
303
- type: 'boolean',
304
- },
305
- is_scheduled_on_device: {
306
- description:
307
- 'Indicates whether the code is set on the device according to a preconfigured schedule.',
308
- type: 'boolean',
309
- },
310
- is_waiting_for_code_assignment: {
311
- description:
312
- 'Indicates whether the access code is waiting for a code assignment.',
313
- type: 'boolean',
314
- },
315
- name: {
316
- description:
317
- 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
318
- nullable: true,
319
- type: 'string',
320
- },
321
- pulled_backup_access_code_id: {
322
- description:
323
- 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.',
324
- format: 'uuid',
325
- nullable: true,
326
- type: 'string',
327
- },
328
- starts_at: {
329
- description:
330
- 'Date and time at which the time-bound access code becomes active.',
331
- format: 'date-time',
332
- nullable: true,
333
- type: 'string',
334
- },
335
- status: {
336
- description:
337
- '\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 ',
338
- enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
339
- type: 'string',
340
- },
341
- type: {
342
- description:
343
- '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.',
344
- enum: ['time_bound', 'ongoing'],
345
- type: 'string',
346
- },
347
- warnings: {
348
- description:
349
- '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.',
350
- items: {
351
- properties: {
352
- message: { type: 'string' },
353
- warning_code: { type: 'string' },
354
- },
355
- required: ['message', 'warning_code'],
356
- type: 'object',
357
- },
358
- type: 'array',
359
- },
360
901
  },
361
902
  required: [
362
903
  'common_code_key',
@@ -4604,13 +5145,52 @@ export default {
4604
5145
  },
4605
5146
  errors: {
4606
5147
  items: {
4607
- properties: {
4608
- error_code: { type: 'string' },
4609
- is_connected_account_error: { enum: [true], type: 'boolean' },
4610
- message: { type: 'string' },
4611
- },
4612
- required: ['message', 'is_connected_account_error', 'error_code'],
4613
- type: 'object',
5148
+ oneOf: [
5149
+ {
5150
+ description: 'Account is disconnected.',
5151
+ properties: {
5152
+ error_code: {
5153
+ description:
5154
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5155
+ enum: ['account_disconnected'],
5156
+ type: 'string',
5157
+ },
5158
+ is_connected_account_error: {
5159
+ enum: [true],
5160
+ type: 'boolean',
5161
+ },
5162
+ message: { type: 'string' },
5163
+ },
5164
+ required: [
5165
+ 'message',
5166
+ 'is_connected_account_error',
5167
+ 'error_code',
5168
+ ],
5169
+ type: 'object',
5170
+ },
5171
+ {
5172
+ description: 'Credentials provided were invalid.',
5173
+ properties: {
5174
+ error_code: {
5175
+ description:
5176
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5177
+ enum: ['invalid_credentials'],
5178
+ type: 'string',
5179
+ },
5180
+ is_connected_account_error: {
5181
+ enum: [true],
5182
+ type: 'boolean',
5183
+ },
5184
+ message: { type: 'string' },
5185
+ },
5186
+ required: [
5187
+ 'message',
5188
+ 'is_connected_account_error',
5189
+ 'error_code',
5190
+ ],
5191
+ type: 'object',
5192
+ },
5193
+ ],
4614
5194
  },
4615
5195
  type: 'array',
4616
5196
  },
@@ -4629,9 +5209,15 @@ export default {
4629
5209
  description: 'Warning associated with the `connected_account`.',
4630
5210
  oneOf: [
4631
5211
  {
5212
+ description: 'Scheduled downtime for account planned.',
4632
5213
  properties: {
4633
5214
  message: { type: 'string' },
4634
- warning_code: { type: 'string' },
5215
+ warning_code: {
5216
+ description:
5217
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5218
+ enum: ['scheduled_maintenance_window'],
5219
+ type: 'string',
5220
+ },
4635
5221
  },
4636
5222
  required: ['message', 'warning_code'],
4637
5223
  type: 'object',
@@ -4981,20 +5567,52 @@ export default {
4981
5567
  ],
4982
5568
  },
4983
5569
  {
4984
- properties: {
4985
- error_code: { type: 'string' },
4986
- is_connected_account_error: {
4987
- enum: [true],
4988
- type: 'boolean',
5570
+ oneOf: [
5571
+ {
5572
+ description: 'Account is disconnected.',
5573
+ properties: {
5574
+ error_code: {
5575
+ description:
5576
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5577
+ enum: ['account_disconnected'],
5578
+ type: 'string',
5579
+ },
5580
+ is_connected_account_error: {
5581
+ enum: [true],
5582
+ type: 'boolean',
5583
+ },
5584
+ message: { type: 'string' },
5585
+ },
5586
+ required: [
5587
+ 'message',
5588
+ 'is_connected_account_error',
5589
+ 'error_code',
5590
+ ],
5591
+ type: 'object',
5592
+ },
5593
+ {
5594
+ description: 'Credentials provided were invalid.',
5595
+ properties: {
5596
+ error_code: {
5597
+ description:
5598
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5599
+ enum: ['invalid_credentials'],
5600
+ type: 'string',
5601
+ },
5602
+ is_connected_account_error: {
5603
+ enum: [true],
5604
+ type: 'boolean',
5605
+ },
5606
+ message: { type: 'string' },
5607
+ },
5608
+ required: [
5609
+ 'message',
5610
+ 'is_connected_account_error',
5611
+ 'error_code',
5612
+ ],
5613
+ type: 'object',
4989
5614
  },
4990
- message: { type: 'string' },
4991
- },
4992
- required: [
4993
- 'message',
4994
- 'is_connected_account_error',
4995
- 'error_code',
4996
5615
  ],
4997
- type: 'object',
4998
5616
  },
4999
5617
  ],
5000
5618
  },
@@ -11217,53 +11835,85 @@ export default {
11217
11835
  type: 'object',
11218
11836
  },
11219
11837
  {
11220
- description: 'The auxiliary heat is running.',
11838
+ description: 'The auxiliary heat is running.',
11839
+ properties: {
11840
+ error_code: {
11841
+ description:
11842
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11843
+ enum: ['auxiliary_heat_running'],
11844
+ type: 'string',
11845
+ },
11846
+ is_device_error: { enum: [true], type: 'boolean' },
11847
+ message: { type: 'string' },
11848
+ },
11849
+ required: ['message', 'is_device_error', 'error_code'],
11850
+ type: 'object',
11851
+ },
11852
+ {
11853
+ description: 'Subscription required to connect.',
11854
+ properties: {
11855
+ error_code: {
11856
+ description:
11857
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11858
+ enum: ['subscription_required'],
11859
+ type: 'string',
11860
+ },
11861
+ is_device_error: { enum: [true], type: 'boolean' },
11862
+ message: { type: 'string' },
11863
+ },
11864
+ required: ['message', 'is_device_error', 'error_code'],
11865
+ type: 'object',
11866
+ },
11867
+ ],
11868
+ },
11869
+ {
11870
+ oneOf: [
11871
+ {
11872
+ description: 'Account is disconnected.',
11221
11873
  properties: {
11222
11874
  error_code: {
11223
11875
  description:
11224
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11225
- enum: ['auxiliary_heat_running'],
11876
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11877
+ enum: ['account_disconnected'],
11226
11878
  type: 'string',
11227
11879
  },
11228
- is_device_error: { enum: [true], type: 'boolean' },
11880
+ is_connected_account_error: {
11881
+ enum: [true],
11882
+ type: 'boolean',
11883
+ },
11229
11884
  message: { type: 'string' },
11230
11885
  },
11231
- required: ['message', 'is_device_error', 'error_code'],
11886
+ required: [
11887
+ 'message',
11888
+ 'is_connected_account_error',
11889
+ 'error_code',
11890
+ ],
11232
11891
  type: 'object',
11233
11892
  },
11234
11893
  {
11235
- description: 'Subscription required to connect.',
11894
+ description: 'Credentials provided were invalid.',
11236
11895
  properties: {
11237
11896
  error_code: {
11238
11897
  description:
11239
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11240
- enum: ['subscription_required'],
11898
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11899
+ enum: ['invalid_credentials'],
11241
11900
  type: 'string',
11242
11901
  },
11243
- is_device_error: { enum: [true], type: 'boolean' },
11902
+ is_connected_account_error: {
11903
+ enum: [true],
11904
+ type: 'boolean',
11905
+ },
11244
11906
  message: { type: 'string' },
11245
11907
  },
11246
- required: ['message', 'is_device_error', 'error_code'],
11908
+ required: [
11909
+ 'message',
11910
+ 'is_connected_account_error',
11911
+ 'error_code',
11912
+ ],
11247
11913
  type: 'object',
11248
11914
  },
11249
11915
  ],
11250
11916
  },
11251
- {
11252
- properties: {
11253
- error_code: { type: 'string' },
11254
- is_connected_account_error: {
11255
- enum: [true],
11256
- type: 'boolean',
11257
- },
11258
- message: { type: 'string' },
11259
- },
11260
- required: [
11261
- 'message',
11262
- 'is_connected_account_error',
11263
- 'error_code',
11264
- ],
11265
- type: 'object',
11266
- },
11267
11917
  ],
11268
11918
  },
11269
11919
  type: 'array',
@@ -11691,13 +12341,381 @@ export default {
11691
12341
  items: {
11692
12342
  oneOf: [
11693
12343
  {
11694
- properties: {
11695
- error_code: { type: 'string' },
11696
- is_access_code_error: { enum: [true], type: 'boolean' },
11697
- message: { type: 'string' },
11698
- },
11699
- required: ['message', 'is_access_code_error', 'error_code'],
11700
- type: 'object',
12344
+ oneOf: [
12345
+ {
12346
+ description: 'Failed to set code on Smart Things device.',
12347
+ properties: {
12348
+ error_code: {
12349
+ description:
12350
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12351
+ enum: ['smartthings_failed_to_set_access_code'],
12352
+ type: 'string',
12353
+ },
12354
+ is_access_code_error: { enum: [true], type: 'boolean' },
12355
+ message: { type: 'string' },
12356
+ },
12357
+ required: [
12358
+ 'message',
12359
+ 'is_access_code_error',
12360
+ 'error_code',
12361
+ ],
12362
+ type: 'object',
12363
+ },
12364
+ {
12365
+ description: 'Failed to set code after multiple retries.',
12366
+ properties: {
12367
+ error_code: {
12368
+ description:
12369
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12370
+ enum: [
12371
+ 'smartthings_failed_to_set_after_multiple_retries',
12372
+ ],
12373
+ type: 'string',
12374
+ },
12375
+ is_access_code_error: { enum: [true], type: 'boolean' },
12376
+ message: { type: 'string' },
12377
+ },
12378
+ required: [
12379
+ 'message',
12380
+ 'is_access_code_error',
12381
+ 'error_code',
12382
+ ],
12383
+ type: 'object',
12384
+ },
12385
+ {
12386
+ description: 'Failed to set code on device.',
12387
+ properties: {
12388
+ error_code: {
12389
+ description:
12390
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12391
+ enum: ['failed_to_set_on_device'],
12392
+ type: 'string',
12393
+ },
12394
+ is_access_code_error: { enum: [true], type: 'boolean' },
12395
+ message: { type: 'string' },
12396
+ },
12397
+ required: [
12398
+ 'message',
12399
+ 'is_access_code_error',
12400
+ 'error_code',
12401
+ ],
12402
+ type: 'object',
12403
+ },
12404
+ {
12405
+ description: 'Failed to remove code from device.',
12406
+ properties: {
12407
+ error_code: {
12408
+ description:
12409
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12410
+ enum: ['failed_to_remove_from_device'],
12411
+ type: 'string',
12412
+ },
12413
+ is_access_code_error: { enum: [true], type: 'boolean' },
12414
+ message: { type: 'string' },
12415
+ },
12416
+ required: [
12417
+ 'message',
12418
+ 'is_access_code_error',
12419
+ 'error_code',
12420
+ ],
12421
+ type: 'object',
12422
+ },
12423
+ {
12424
+ description: 'Duplicate access code detected on device.',
12425
+ properties: {
12426
+ error_code: {
12427
+ description:
12428
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12429
+ enum: ['duplicate_code_on_device'],
12430
+ type: 'string',
12431
+ },
12432
+ is_access_code_error: { enum: [true], type: 'boolean' },
12433
+ message: { type: 'string' },
12434
+ },
12435
+ required: [
12436
+ 'message',
12437
+ 'is_access_code_error',
12438
+ 'error_code',
12439
+ ],
12440
+ type: 'object',
12441
+ },
12442
+ {
12443
+ description:
12444
+ 'An attempt to modify this access code was prevented.',
12445
+ properties: {
12446
+ error_code: {
12447
+ description:
12448
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12449
+ enum: ['duplicate_code_attempt_prevented'],
12450
+ type: 'string',
12451
+ },
12452
+ is_access_code_error: { enum: [true], type: 'boolean' },
12453
+ message: { type: 'string' },
12454
+ },
12455
+ required: [
12456
+ 'message',
12457
+ 'is_access_code_error',
12458
+ 'error_code',
12459
+ ],
12460
+ type: 'object',
12461
+ },
12462
+ {
12463
+ description:
12464
+ 'Igloohome bridge has too many pending jobs in the queue.',
12465
+ properties: {
12466
+ error_code: {
12467
+ description:
12468
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12469
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
12470
+ type: 'string',
12471
+ },
12472
+ is_access_code_error: { enum: [true], type: 'boolean' },
12473
+ message: { type: 'string' },
12474
+ },
12475
+ required: [
12476
+ 'message',
12477
+ 'is_access_code_error',
12478
+ 'error_code',
12479
+ ],
12480
+ type: 'object',
12481
+ },
12482
+ {
12483
+ description: 'Igloohome bridge is offline.',
12484
+ properties: {
12485
+ error_code: {
12486
+ description:
12487
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12488
+ enum: ['igloohome_bridge_offline'],
12489
+ type: 'string',
12490
+ },
12491
+ is_access_code_error: { enum: [true], type: 'boolean' },
12492
+ message: { type: 'string' },
12493
+ },
12494
+ required: [
12495
+ 'message',
12496
+ 'is_access_code_error',
12497
+ 'error_code',
12498
+ ],
12499
+ type: 'object',
12500
+ },
12501
+ {
12502
+ description: 'Lock as reached max amount of codes.',
12503
+ properties: {
12504
+ error_code: {
12505
+ description:
12506
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12507
+ enum: [
12508
+ 'igloohome_offline_access_code_no_variance_available',
12509
+ ],
12510
+ type: 'string',
12511
+ },
12512
+ is_access_code_error: { enum: [true], type: 'boolean' },
12513
+ message: { type: 'string' },
12514
+ },
12515
+ required: [
12516
+ 'message',
12517
+ 'is_access_code_error',
12518
+ 'error_code',
12519
+ ],
12520
+ type: 'object',
12521
+ },
12522
+ {
12523
+ description:
12524
+ 'Unable to confirm the access code is set on Kwikset device.',
12525
+ properties: {
12526
+ error_code: {
12527
+ description:
12528
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12529
+ enum: ['kwikset_unable_to_confirm_code'],
12530
+ type: 'string',
12531
+ },
12532
+ is_access_code_error: { enum: [true], type: 'boolean' },
12533
+ message: { type: 'string' },
12534
+ },
12535
+ required: [
12536
+ 'message',
12537
+ 'is_access_code_error',
12538
+ 'error_code',
12539
+ ],
12540
+ type: 'object',
12541
+ },
12542
+ {
12543
+ description:
12544
+ 'Unable to confirm the deletion of the access code on Kwikset device.',
12545
+ properties: {
12546
+ error_code: {
12547
+ description:
12548
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12549
+ enum: ['kwikset_unable_to_confirm_deletion'],
12550
+ type: 'string',
12551
+ },
12552
+ is_access_code_error: { enum: [true], type: 'boolean' },
12553
+ message: { type: 'string' },
12554
+ },
12555
+ required: [
12556
+ 'message',
12557
+ 'is_access_code_error',
12558
+ 'error_code',
12559
+ ],
12560
+ type: 'object',
12561
+ },
12562
+ {
12563
+ description:
12564
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
12565
+ properties: {
12566
+ error_code: {
12567
+ description:
12568
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12569
+ enum: ['code_modified_external_to_seam'],
12570
+ type: 'string',
12571
+ },
12572
+ is_access_code_error: { enum: [true], type: 'boolean' },
12573
+ message: { type: 'string' },
12574
+ },
12575
+ required: [
12576
+ 'message',
12577
+ 'is_access_code_error',
12578
+ 'error_code',
12579
+ ],
12580
+ type: 'object',
12581
+ },
12582
+ {
12583
+ description: 'Invalid code length for August lock.',
12584
+ properties: {
12585
+ error_code: {
12586
+ description:
12587
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12588
+ enum: ['august_lock_invalid_code_length'],
12589
+ type: 'string',
12590
+ },
12591
+ is_access_code_error: { enum: [true], type: 'boolean' },
12592
+ message: { type: 'string' },
12593
+ },
12594
+ required: [
12595
+ 'message',
12596
+ 'is_access_code_error',
12597
+ 'error_code',
12598
+ ],
12599
+ type: 'object',
12600
+ },
12601
+ {
12602
+ description:
12603
+ 'Access code has not yet been fully moved to the device.',
12604
+ properties: {
12605
+ error_code: {
12606
+ description:
12607
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12608
+ enum: ['august_device_programming_delay'],
12609
+ type: 'string',
12610
+ },
12611
+ is_access_code_error: { enum: [true], type: 'boolean' },
12612
+ message: { type: 'string' },
12613
+ },
12614
+ required: [
12615
+ 'message',
12616
+ 'is_access_code_error',
12617
+ 'error_code',
12618
+ ],
12619
+ type: 'object',
12620
+ },
12621
+ {
12622
+ description:
12623
+ 'All access code slots on the device are full.',
12624
+ properties: {
12625
+ error_code: {
12626
+ description:
12627
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12628
+ enum: ['august_device_slots_full'],
12629
+ type: 'string',
12630
+ },
12631
+ is_access_code_error: { enum: [true], type: 'boolean' },
12632
+ message: { type: 'string' },
12633
+ },
12634
+ required: [
12635
+ 'message',
12636
+ 'is_access_code_error',
12637
+ 'error_code',
12638
+ ],
12639
+ type: 'object',
12640
+ },
12641
+ {
12642
+ description: 'August lock is missing a keypad.',
12643
+ properties: {
12644
+ error_code: {
12645
+ description:
12646
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12647
+ enum: ['august_lock_missing_keypad'],
12648
+ type: 'string',
12649
+ },
12650
+ is_access_code_error: { enum: [true], type: 'boolean' },
12651
+ message: { type: 'string' },
12652
+ },
12653
+ required: [
12654
+ 'message',
12655
+ 'is_access_code_error',
12656
+ 'error_code',
12657
+ ],
12658
+ type: 'object',
12659
+ },
12660
+ {
12661
+ description: 'Salto site user is not subscribed.',
12662
+ properties: {
12663
+ error_code: {
12664
+ description:
12665
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12666
+ enum: ['salto_site_user_not_subscribed'],
12667
+ type: 'string',
12668
+ },
12669
+ is_access_code_error: { enum: [true], type: 'boolean' },
12670
+ message: { type: 'string' },
12671
+ },
12672
+ required: [
12673
+ 'message',
12674
+ 'is_access_code_error',
12675
+ 'error_code',
12676
+ ],
12677
+ type: 'object',
12678
+ },
12679
+ {
12680
+ description:
12681
+ 'Access code has not yet been fully moved to the device.',
12682
+ properties: {
12683
+ error_code: {
12684
+ description:
12685
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12686
+ enum: ['hubitat_device_programming_delay'],
12687
+ type: 'string',
12688
+ },
12689
+ is_access_code_error: { enum: [true], type: 'boolean' },
12690
+ message: { type: 'string' },
12691
+ },
12692
+ required: [
12693
+ 'message',
12694
+ 'is_access_code_error',
12695
+ 'error_code',
12696
+ ],
12697
+ type: 'object',
12698
+ },
12699
+ {
12700
+ description: 'No free positions available on the device.',
12701
+ properties: {
12702
+ error_code: {
12703
+ description:
12704
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12705
+ enum: ['hubitat_no_free_positions_available'],
12706
+ type: 'string',
12707
+ },
12708
+ is_access_code_error: { enum: [true], type: 'boolean' },
12709
+ message: { type: 'string' },
12710
+ },
12711
+ required: [
12712
+ 'message',
12713
+ 'is_access_code_error',
12714
+ 'error_code',
12715
+ ],
12716
+ type: 'object',
12717
+ },
12718
+ ],
11701
12719
  },
11702
12720
  {
11703
12721
  description: 'Error associated with the `device`.',
@@ -11901,20 +12919,52 @@ export default {
11901
12919
  ],
11902
12920
  },
11903
12921
  {
11904
- properties: {
11905
- error_code: { type: 'string' },
11906
- is_connected_account_error: {
11907
- enum: [true],
11908
- type: 'boolean',
12922
+ oneOf: [
12923
+ {
12924
+ description: 'Account is disconnected.',
12925
+ properties: {
12926
+ error_code: {
12927
+ description:
12928
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12929
+ enum: ['account_disconnected'],
12930
+ type: 'string',
12931
+ },
12932
+ is_connected_account_error: {
12933
+ enum: [true],
12934
+ type: 'boolean',
12935
+ },
12936
+ message: { type: 'string' },
12937
+ },
12938
+ required: [
12939
+ 'message',
12940
+ 'is_connected_account_error',
12941
+ 'error_code',
12942
+ ],
12943
+ type: 'object',
12944
+ },
12945
+ {
12946
+ description: 'Credentials provided were invalid.',
12947
+ properties: {
12948
+ error_code: {
12949
+ description:
12950
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12951
+ enum: ['invalid_credentials'],
12952
+ type: 'string',
12953
+ },
12954
+ is_connected_account_error: {
12955
+ enum: [true],
12956
+ type: 'boolean',
12957
+ },
12958
+ message: { type: 'string' },
12959
+ },
12960
+ required: [
12961
+ 'message',
12962
+ 'is_connected_account_error',
12963
+ 'error_code',
12964
+ ],
12965
+ type: 'object',
11909
12966
  },
11910
- message: { type: 'string' },
11911
- },
11912
- required: [
11913
- 'message',
11914
- 'is_connected_account_error',
11915
- 'error_code',
11916
12967
  ],
11917
- type: 'object',
11918
12968
  },
11919
12969
  ],
11920
12970
  },
@@ -11945,12 +12995,153 @@ export default {
11945
12995
  description:
11946
12996
  '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.',
11947
12997
  items: {
11948
- properties: {
11949
- message: { type: 'string' },
11950
- warning_code: { type: 'string' },
11951
- },
11952
- required: ['message', 'warning_code'],
11953
- type: 'object',
12998
+ oneOf: [
12999
+ {
13000
+ description: 'Failed to set code on Smart Things device.',
13001
+ properties: {
13002
+ message: { type: 'string' },
13003
+ warning_code: {
13004
+ description:
13005
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13006
+ enum: ['smartthings_failed_to_set_access_code'],
13007
+ type: 'string',
13008
+ },
13009
+ },
13010
+ required: ['message', 'warning_code'],
13011
+ type: 'object',
13012
+ },
13013
+ {
13014
+ description: 'Duplicate access code detected.',
13015
+ properties: {
13016
+ message: { type: 'string' },
13017
+ warning_code: {
13018
+ description:
13019
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13020
+ enum: ['schlage_detected_duplicate'],
13021
+ type: 'string',
13022
+ },
13023
+ },
13024
+ required: ['message', 'warning_code'],
13025
+ type: 'object',
13026
+ },
13027
+ {
13028
+ description:
13029
+ 'Received an error when attempting to create this code.',
13030
+ properties: {
13031
+ message: { type: 'string' },
13032
+ warning_code: {
13033
+ description:
13034
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13035
+ enum: ['schlage_creation_outage'],
13036
+ type: 'string',
13037
+ },
13038
+ },
13039
+ required: ['message', 'warning_code'],
13040
+ type: 'object',
13041
+ },
13042
+ {
13043
+ description:
13044
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
13045
+ properties: {
13046
+ message: { type: 'string' },
13047
+ warning_code: {
13048
+ description:
13049
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13050
+ enum: ['code_modified_external_to_seam'],
13051
+ type: 'string',
13052
+ },
13053
+ },
13054
+ required: ['message', 'warning_code'],
13055
+ type: 'object',
13056
+ },
13057
+ {
13058
+ description: 'Delay in setting code on device.',
13059
+ properties: {
13060
+ message: { type: 'string' },
13061
+ warning_code: {
13062
+ description:
13063
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13064
+ enum: ['delay_in_setting_on_device'],
13065
+ type: 'string',
13066
+ },
13067
+ },
13068
+ required: ['message', 'warning_code'],
13069
+ type: 'object',
13070
+ },
13071
+ {
13072
+ description: 'Delay in removing code from device.',
13073
+ properties: {
13074
+ message: { type: 'string' },
13075
+ warning_code: {
13076
+ description:
13077
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13078
+ enum: ['delay_in_removing_from_device'],
13079
+ type: 'string',
13080
+ },
13081
+ },
13082
+ required: ['message', 'warning_code'],
13083
+ type: 'object',
13084
+ },
13085
+ {
13086
+ description:
13087
+ 'Third party integration detected that may cause access codes to fail.',
13088
+ properties: {
13089
+ message: { type: 'string' },
13090
+ warning_code: {
13091
+ description:
13092
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13093
+ enum: ['third_party_integration_detected'],
13094
+ type: 'string',
13095
+ },
13096
+ },
13097
+ required: ['message', 'warning_code'],
13098
+ type: 'object',
13099
+ },
13100
+ {
13101
+ description:
13102
+ 'Access code has not yet been fully moved to the device.',
13103
+ properties: {
13104
+ message: { type: 'string' },
13105
+ warning_code: {
13106
+ description:
13107
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13108
+ enum: ['august_device_programming_delay'],
13109
+ type: 'string',
13110
+ },
13111
+ },
13112
+ required: ['message', 'warning_code'],
13113
+ type: 'object',
13114
+ },
13115
+ {
13116
+ description: 'Algopins must be used within 24 hours.',
13117
+ properties: {
13118
+ message: { type: 'string' },
13119
+ warning_code: {
13120
+ description:
13121
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13122
+ enum: ['igloo_algopin_must_be_used_within_24_hours'],
13123
+ type: 'string',
13124
+ },
13125
+ },
13126
+ required: ['message', 'warning_code'],
13127
+ type: 'object',
13128
+ },
13129
+ {
13130
+ description:
13131
+ 'Management was transferred to another workspace.',
13132
+ properties: {
13133
+ message: { type: 'string' },
13134
+ warning_code: {
13135
+ description:
13136
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13137
+ enum: ['management_transferred'],
13138
+ type: 'string',
13139
+ },
13140
+ },
13141
+ required: ['message', 'warning_code'],
13142
+ type: 'object',
13143
+ },
13144
+ ],
11954
13145
  },
11955
13146
  type: 'array',
11956
13147
  },
@@ -12274,20 +13465,52 @@ export default {
12274
13465
  ],
12275
13466
  },
12276
13467
  {
12277
- properties: {
12278
- error_code: { type: 'string' },
12279
- is_connected_account_error: {
12280
- enum: [true],
12281
- type: 'boolean',
13468
+ oneOf: [
13469
+ {
13470
+ description: 'Account is disconnected.',
13471
+ properties: {
13472
+ error_code: {
13473
+ description:
13474
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13475
+ enum: ['account_disconnected'],
13476
+ type: 'string',
13477
+ },
13478
+ is_connected_account_error: {
13479
+ enum: [true],
13480
+ type: 'boolean',
13481
+ },
13482
+ message: { type: 'string' },
13483
+ },
13484
+ required: [
13485
+ 'message',
13486
+ 'is_connected_account_error',
13487
+ 'error_code',
13488
+ ],
13489
+ type: 'object',
13490
+ },
13491
+ {
13492
+ description: 'Credentials provided were invalid.',
13493
+ properties: {
13494
+ error_code: {
13495
+ description:
13496
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13497
+ enum: ['invalid_credentials'],
13498
+ type: 'string',
13499
+ },
13500
+ is_connected_account_error: {
13501
+ enum: [true],
13502
+ type: 'boolean',
13503
+ },
13504
+ message: { type: 'string' },
13505
+ },
13506
+ required: [
13507
+ 'message',
13508
+ 'is_connected_account_error',
13509
+ 'error_code',
13510
+ ],
13511
+ type: 'object',
12282
13512
  },
12283
- message: { type: 'string' },
12284
- },
12285
- required: [
12286
- 'message',
12287
- 'is_connected_account_error',
12288
- 'error_code',
12289
13513
  ],
12290
- type: 'object',
12291
13514
  },
12292
13515
  ],
12293
13516
  },