@seamapi/types 1.332.1 → 1.334.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 (33) hide show
  1. package/dist/connect.cjs +1541 -161
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +4917 -923
  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/acs/acs-credential.d.ts +66 -0
  9. package/lib/seam/connect/models/acs/acs-credential.js +4 -1
  10. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  11. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.d.ts +20 -0
  12. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.js +7 -0
  13. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.js.map +1 -1
  14. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +216 -0
  15. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +94 -0
  16. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +122 -0
  17. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +85 -23
  18. package/lib/seam/connect/models/connected-accounts/connected-account.js +27 -9
  19. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  20. package/lib/seam/connect/models/devices/device.d.ts +28 -7
  21. package/lib/seam/connect/models/devices/phone.d.ts +28 -7
  22. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +28 -7
  23. package/lib/seam/connect/openapi.d.ts +309 -164
  24. package/lib/seam/connect/openapi.js +1346 -104
  25. package/lib/seam/connect/openapi.js.map +1 -1
  26. package/lib/seam/connect/route-types.d.ts +2391 -310
  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/acs/acs-credential.ts +7 -1
  30. package/src/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.ts +12 -0
  31. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +32 -9
  32. package/src/lib/seam/connect/openapi.ts +1518 -173
  33. package/src/lib/seam/connect/route-types.ts +3016 -297
@@ -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`.',
@@ -254,109 +622,282 @@ export default {
254
622
  ],
255
623
  },
256
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.',
257
754
  properties: {
258
- error_code: { type: 'string' },
259
- is_connected_account_error: {
260
- enum: [true],
261
- type: 'boolean',
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',
262
761
  },
762
+ },
763
+ required: ['message', 'warning_code'],
764
+ type: 'object',
765
+ },
766
+ {
767
+ description: 'Duplicate access code detected.',
768
+ properties: {
263
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
+ },
264
776
  },
265
- required: [
266
- 'message',
267
- 'is_connected_account_error',
268
- 'error_code',
269
- ],
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',
852
+ },
853
+ {
854
+ description:
855
+ 'Access code has not yet been fully moved to the device.',
856
+ properties: {
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',
863
+ },
864
+ },
865
+ required: ['message', 'warning_code'],
866
+ type: 'object',
867
+ },
868
+ {
869
+ description: 'Algopins must be used within 24 hours.',
870
+ properties: {
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
+ },
878
+ },
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',
@@ -516,6 +1057,20 @@ export default {
516
1057
  format: 'uuid',
517
1058
  type: 'string',
518
1059
  },
1060
+ assa_abloy_vostio_metadata: {
1061
+ description: 'Vostio-specific metadata for the credential.',
1062
+ properties: {
1063
+ door_names: { items: { type: 'string' }, type: 'array' },
1064
+ endpoint_id: { type: 'string' },
1065
+ key_id: { type: 'string' },
1066
+ key_issuing_request_id: { type: 'string' },
1067
+ override_guest_acs_entrance_ids: {
1068
+ items: { type: 'string' },
1069
+ type: 'array',
1070
+ },
1071
+ },
1072
+ type: 'object',
1073
+ },
519
1074
  card_number: { nullable: true, type: 'string' },
520
1075
  code: {
521
1076
  description: 'Access (PIN) code for the credential.',
@@ -2011,6 +2566,24 @@ export default {
2011
2566
  format: 'uuid',
2012
2567
  type: 'string',
2013
2568
  },
2569
+ assa_abloy_vostio_metadata: {
2570
+ description:
2571
+ 'Vostio-specific metadata for the credential.',
2572
+ properties: {
2573
+ door_names: {
2574
+ items: { type: 'string' },
2575
+ type: 'array',
2576
+ },
2577
+ endpoint_id: { type: 'string' },
2578
+ key_id: { type: 'string' },
2579
+ key_issuing_request_id: { type: 'string' },
2580
+ override_guest_acs_entrance_ids: {
2581
+ items: { type: 'string' },
2582
+ type: 'array',
2583
+ },
2584
+ },
2585
+ type: 'object',
2586
+ },
2014
2587
  card_number: { nullable: true, type: 'string' },
2015
2588
  code: {
2016
2589
  description:
@@ -2373,6 +2946,24 @@ export default {
2373
2946
  format: 'uuid',
2374
2947
  type: 'string',
2375
2948
  },
2949
+ assa_abloy_vostio_metadata: {
2950
+ description:
2951
+ 'Vostio-specific metadata for the credential.',
2952
+ properties: {
2953
+ door_names: {
2954
+ items: { type: 'string' },
2955
+ type: 'array',
2956
+ },
2957
+ endpoint_id: { type: 'string' },
2958
+ key_id: { type: 'string' },
2959
+ key_issuing_request_id: { type: 'string' },
2960
+ override_guest_acs_entrance_ids: {
2961
+ items: { type: 'string' },
2962
+ type: 'array',
2963
+ },
2964
+ },
2965
+ type: 'object',
2966
+ },
2376
2967
  card_number: { nullable: true, type: 'string' },
2377
2968
  code: {
2378
2969
  description:
@@ -2869,6 +3460,24 @@ export default {
2869
3460
  format: 'uuid',
2870
3461
  type: 'string',
2871
3462
  },
3463
+ assa_abloy_vostio_metadata: {
3464
+ description:
3465
+ 'Vostio-specific metadata for the credential.',
3466
+ properties: {
3467
+ door_names: {
3468
+ items: { type: 'string' },
3469
+ type: 'array',
3470
+ },
3471
+ endpoint_id: { type: 'string' },
3472
+ key_id: { type: 'string' },
3473
+ key_issuing_request_id: { type: 'string' },
3474
+ override_guest_acs_entrance_ids: {
3475
+ items: { type: 'string' },
3476
+ type: 'array',
3477
+ },
3478
+ },
3479
+ type: 'object',
3480
+ },
2872
3481
  card_number: { nullable: true, type: 'string' },
2873
3482
  code: {
2874
3483
  description: 'Access (PIN) code for the credential.',
@@ -3228,6 +3837,24 @@ export default {
3228
3837
  format: 'uuid',
3229
3838
  type: 'string',
3230
3839
  },
3840
+ assa_abloy_vostio_metadata: {
3841
+ description:
3842
+ 'Vostio-specific metadata for the credential.',
3843
+ properties: {
3844
+ door_names: {
3845
+ items: { type: 'string' },
3846
+ type: 'array',
3847
+ },
3848
+ endpoint_id: { type: 'string' },
3849
+ key_id: { type: 'string' },
3850
+ key_issuing_request_id: { type: 'string' },
3851
+ override_guest_acs_entrance_ids: {
3852
+ items: { type: 'string' },
3853
+ type: 'array',
3854
+ },
3855
+ },
3856
+ type: 'object',
3857
+ },
3231
3858
  card_number: { nullable: true, type: 'string' },
3232
3859
  code: {
3233
3860
  description: 'Access (PIN) code for the credential.',
@@ -4604,13 +5231,52 @@ export default {
4604
5231
  },
4605
5232
  errors: {
4606
5233
  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',
5234
+ oneOf: [
5235
+ {
5236
+ description: 'Account is disconnected.',
5237
+ properties: {
5238
+ error_code: {
5239
+ description:
5240
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5241
+ enum: ['account_disconnected'],
5242
+ type: 'string',
5243
+ },
5244
+ is_connected_account_error: {
5245
+ enum: [true],
5246
+ type: 'boolean',
5247
+ },
5248
+ message: { type: 'string' },
5249
+ },
5250
+ required: [
5251
+ 'message',
5252
+ 'is_connected_account_error',
5253
+ 'error_code',
5254
+ ],
5255
+ type: 'object',
5256
+ },
5257
+ {
5258
+ description: 'Credentials provided were invalid.',
5259
+ properties: {
5260
+ error_code: {
5261
+ description:
5262
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5263
+ enum: ['invalid_credentials'],
5264
+ type: 'string',
5265
+ },
5266
+ is_connected_account_error: {
5267
+ enum: [true],
5268
+ type: 'boolean',
5269
+ },
5270
+ message: { type: 'string' },
5271
+ },
5272
+ required: [
5273
+ 'message',
5274
+ 'is_connected_account_error',
5275
+ 'error_code',
5276
+ ],
5277
+ type: 'object',
5278
+ },
5279
+ ],
4614
5280
  },
4615
5281
  type: 'array',
4616
5282
  },
@@ -4629,9 +5295,15 @@ export default {
4629
5295
  description: 'Warning associated with the `connected_account`.',
4630
5296
  oneOf: [
4631
5297
  {
5298
+ description: 'Scheduled downtime for account planned.',
4632
5299
  properties: {
4633
5300
  message: { type: 'string' },
4634
- warning_code: { type: 'string' },
5301
+ warning_code: {
5302
+ description:
5303
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5304
+ enum: ['scheduled_maintenance_window'],
5305
+ type: 'string',
5306
+ },
4635
5307
  },
4636
5308
  required: ['message', 'warning_code'],
4637
5309
  type: 'object',
@@ -4981,20 +5653,52 @@ export default {
4981
5653
  ],
4982
5654
  },
4983
5655
  {
4984
- properties: {
4985
- error_code: { type: 'string' },
4986
- is_connected_account_error: {
4987
- enum: [true],
4988
- type: 'boolean',
5656
+ oneOf: [
5657
+ {
5658
+ description: 'Account is disconnected.',
5659
+ properties: {
5660
+ error_code: {
5661
+ description:
5662
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5663
+ enum: ['account_disconnected'],
5664
+ type: 'string',
5665
+ },
5666
+ is_connected_account_error: {
5667
+ enum: [true],
5668
+ type: 'boolean',
5669
+ },
5670
+ message: { type: 'string' },
5671
+ },
5672
+ required: [
5673
+ 'message',
5674
+ 'is_connected_account_error',
5675
+ 'error_code',
5676
+ ],
5677
+ type: 'object',
5678
+ },
5679
+ {
5680
+ description: 'Credentials provided were invalid.',
5681
+ properties: {
5682
+ error_code: {
5683
+ description:
5684
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5685
+ enum: ['invalid_credentials'],
5686
+ type: 'string',
5687
+ },
5688
+ is_connected_account_error: {
5689
+ enum: [true],
5690
+ type: 'boolean',
5691
+ },
5692
+ message: { type: 'string' },
5693
+ },
5694
+ required: [
5695
+ 'message',
5696
+ 'is_connected_account_error',
5697
+ 'error_code',
5698
+ ],
5699
+ type: 'object',
4989
5700
  },
4990
- message: { type: 'string' },
4991
- },
4992
- required: [
4993
- 'message',
4994
- 'is_connected_account_error',
4995
- 'error_code',
4996
5701
  ],
4997
- type: 'object',
4998
5702
  },
4999
5703
  ],
5000
5704
  },
@@ -11248,22 +11952,54 @@ export default {
11248
11952
  },
11249
11953
  ],
11250
11954
  },
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
- },
11955
+ {
11956
+ oneOf: [
11957
+ {
11958
+ description: 'Account is disconnected.',
11959
+ properties: {
11960
+ error_code: {
11961
+ description:
11962
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11963
+ enum: ['account_disconnected'],
11964
+ type: 'string',
11965
+ },
11966
+ is_connected_account_error: {
11967
+ enum: [true],
11968
+ type: 'boolean',
11969
+ },
11970
+ message: { type: 'string' },
11971
+ },
11972
+ required: [
11973
+ 'message',
11974
+ 'is_connected_account_error',
11975
+ 'error_code',
11976
+ ],
11977
+ type: 'object',
11978
+ },
11979
+ {
11980
+ description: 'Credentials provided were invalid.',
11981
+ properties: {
11982
+ error_code: {
11983
+ description:
11984
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11985
+ enum: ['invalid_credentials'],
11986
+ type: 'string',
11987
+ },
11988
+ is_connected_account_error: {
11989
+ enum: [true],
11990
+ type: 'boolean',
11991
+ },
11992
+ message: { type: 'string' },
11993
+ },
11994
+ required: [
11995
+ 'message',
11996
+ 'is_connected_account_error',
11997
+ 'error_code',
11998
+ ],
11999
+ type: 'object',
12000
+ },
12001
+ ],
12002
+ },
11267
12003
  ],
11268
12004
  },
11269
12005
  type: 'array',
@@ -11691,13 +12427,381 @@ export default {
11691
12427
  items: {
11692
12428
  oneOf: [
11693
12429
  {
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',
12430
+ oneOf: [
12431
+ {
12432
+ description: 'Failed to set code on Smart Things device.',
12433
+ properties: {
12434
+ error_code: {
12435
+ description:
12436
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12437
+ enum: ['smartthings_failed_to_set_access_code'],
12438
+ type: 'string',
12439
+ },
12440
+ is_access_code_error: { enum: [true], type: 'boolean' },
12441
+ message: { type: 'string' },
12442
+ },
12443
+ required: [
12444
+ 'message',
12445
+ 'is_access_code_error',
12446
+ 'error_code',
12447
+ ],
12448
+ type: 'object',
12449
+ },
12450
+ {
12451
+ description: 'Failed to set code after multiple retries.',
12452
+ properties: {
12453
+ error_code: {
12454
+ description:
12455
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12456
+ enum: [
12457
+ 'smartthings_failed_to_set_after_multiple_retries',
12458
+ ],
12459
+ type: 'string',
12460
+ },
12461
+ is_access_code_error: { enum: [true], type: 'boolean' },
12462
+ message: { type: 'string' },
12463
+ },
12464
+ required: [
12465
+ 'message',
12466
+ 'is_access_code_error',
12467
+ 'error_code',
12468
+ ],
12469
+ type: 'object',
12470
+ },
12471
+ {
12472
+ description: 'Failed to set code on device.',
12473
+ properties: {
12474
+ error_code: {
12475
+ description:
12476
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12477
+ enum: ['failed_to_set_on_device'],
12478
+ type: 'string',
12479
+ },
12480
+ is_access_code_error: { enum: [true], type: 'boolean' },
12481
+ message: { type: 'string' },
12482
+ },
12483
+ required: [
12484
+ 'message',
12485
+ 'is_access_code_error',
12486
+ 'error_code',
12487
+ ],
12488
+ type: 'object',
12489
+ },
12490
+ {
12491
+ description: 'Failed to remove code from device.',
12492
+ properties: {
12493
+ error_code: {
12494
+ description:
12495
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12496
+ enum: ['failed_to_remove_from_device'],
12497
+ type: 'string',
12498
+ },
12499
+ is_access_code_error: { enum: [true], type: 'boolean' },
12500
+ message: { type: 'string' },
12501
+ },
12502
+ required: [
12503
+ 'message',
12504
+ 'is_access_code_error',
12505
+ 'error_code',
12506
+ ],
12507
+ type: 'object',
12508
+ },
12509
+ {
12510
+ description: 'Duplicate access code detected on device.',
12511
+ properties: {
12512
+ error_code: {
12513
+ description:
12514
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12515
+ enum: ['duplicate_code_on_device'],
12516
+ type: 'string',
12517
+ },
12518
+ is_access_code_error: { enum: [true], type: 'boolean' },
12519
+ message: { type: 'string' },
12520
+ },
12521
+ required: [
12522
+ 'message',
12523
+ 'is_access_code_error',
12524
+ 'error_code',
12525
+ ],
12526
+ type: 'object',
12527
+ },
12528
+ {
12529
+ description:
12530
+ 'An attempt to modify this access code was prevented.',
12531
+ properties: {
12532
+ error_code: {
12533
+ description:
12534
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12535
+ enum: ['duplicate_code_attempt_prevented'],
12536
+ type: 'string',
12537
+ },
12538
+ is_access_code_error: { enum: [true], type: 'boolean' },
12539
+ message: { type: 'string' },
12540
+ },
12541
+ required: [
12542
+ 'message',
12543
+ 'is_access_code_error',
12544
+ 'error_code',
12545
+ ],
12546
+ type: 'object',
12547
+ },
12548
+ {
12549
+ description:
12550
+ 'Igloohome bridge has too many pending jobs in the queue.',
12551
+ properties: {
12552
+ error_code: {
12553
+ description:
12554
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12555
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
12556
+ type: 'string',
12557
+ },
12558
+ is_access_code_error: { enum: [true], type: 'boolean' },
12559
+ message: { type: 'string' },
12560
+ },
12561
+ required: [
12562
+ 'message',
12563
+ 'is_access_code_error',
12564
+ 'error_code',
12565
+ ],
12566
+ type: 'object',
12567
+ },
12568
+ {
12569
+ description: 'Igloohome bridge is offline.',
12570
+ properties: {
12571
+ error_code: {
12572
+ description:
12573
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12574
+ enum: ['igloohome_bridge_offline'],
12575
+ type: 'string',
12576
+ },
12577
+ is_access_code_error: { enum: [true], type: 'boolean' },
12578
+ message: { type: 'string' },
12579
+ },
12580
+ required: [
12581
+ 'message',
12582
+ 'is_access_code_error',
12583
+ 'error_code',
12584
+ ],
12585
+ type: 'object',
12586
+ },
12587
+ {
12588
+ description: 'Lock as reached max amount of codes.',
12589
+ properties: {
12590
+ error_code: {
12591
+ description:
12592
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12593
+ enum: [
12594
+ 'igloohome_offline_access_code_no_variance_available',
12595
+ ],
12596
+ type: 'string',
12597
+ },
12598
+ is_access_code_error: { enum: [true], type: 'boolean' },
12599
+ message: { type: 'string' },
12600
+ },
12601
+ required: [
12602
+ 'message',
12603
+ 'is_access_code_error',
12604
+ 'error_code',
12605
+ ],
12606
+ type: 'object',
12607
+ },
12608
+ {
12609
+ description:
12610
+ 'Unable to confirm the access code is set on Kwikset device.',
12611
+ properties: {
12612
+ error_code: {
12613
+ description:
12614
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12615
+ enum: ['kwikset_unable_to_confirm_code'],
12616
+ type: 'string',
12617
+ },
12618
+ is_access_code_error: { enum: [true], type: 'boolean' },
12619
+ message: { type: 'string' },
12620
+ },
12621
+ required: [
12622
+ 'message',
12623
+ 'is_access_code_error',
12624
+ 'error_code',
12625
+ ],
12626
+ type: 'object',
12627
+ },
12628
+ {
12629
+ description:
12630
+ 'Unable to confirm the deletion of the access code on Kwikset device.',
12631
+ properties: {
12632
+ error_code: {
12633
+ description:
12634
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12635
+ enum: ['kwikset_unable_to_confirm_deletion'],
12636
+ type: 'string',
12637
+ },
12638
+ is_access_code_error: { enum: [true], type: 'boolean' },
12639
+ message: { type: 'string' },
12640
+ },
12641
+ required: [
12642
+ 'message',
12643
+ 'is_access_code_error',
12644
+ 'error_code',
12645
+ ],
12646
+ type: 'object',
12647
+ },
12648
+ {
12649
+ description:
12650
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
12651
+ properties: {
12652
+ error_code: {
12653
+ description:
12654
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12655
+ enum: ['code_modified_external_to_seam'],
12656
+ type: 'string',
12657
+ },
12658
+ is_access_code_error: { enum: [true], type: 'boolean' },
12659
+ message: { type: 'string' },
12660
+ },
12661
+ required: [
12662
+ 'message',
12663
+ 'is_access_code_error',
12664
+ 'error_code',
12665
+ ],
12666
+ type: 'object',
12667
+ },
12668
+ {
12669
+ description: 'Invalid code length for August lock.',
12670
+ properties: {
12671
+ error_code: {
12672
+ description:
12673
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12674
+ enum: ['august_lock_invalid_code_length'],
12675
+ type: 'string',
12676
+ },
12677
+ is_access_code_error: { enum: [true], type: 'boolean' },
12678
+ message: { type: 'string' },
12679
+ },
12680
+ required: [
12681
+ 'message',
12682
+ 'is_access_code_error',
12683
+ 'error_code',
12684
+ ],
12685
+ type: 'object',
12686
+ },
12687
+ {
12688
+ description:
12689
+ 'Access code has not yet been fully moved to the device.',
12690
+ properties: {
12691
+ error_code: {
12692
+ description:
12693
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12694
+ enum: ['august_device_programming_delay'],
12695
+ type: 'string',
12696
+ },
12697
+ is_access_code_error: { enum: [true], type: 'boolean' },
12698
+ message: { type: 'string' },
12699
+ },
12700
+ required: [
12701
+ 'message',
12702
+ 'is_access_code_error',
12703
+ 'error_code',
12704
+ ],
12705
+ type: 'object',
12706
+ },
12707
+ {
12708
+ description:
12709
+ 'All access code slots on the device are full.',
12710
+ properties: {
12711
+ error_code: {
12712
+ description:
12713
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12714
+ enum: ['august_device_slots_full'],
12715
+ type: 'string',
12716
+ },
12717
+ is_access_code_error: { enum: [true], type: 'boolean' },
12718
+ message: { type: 'string' },
12719
+ },
12720
+ required: [
12721
+ 'message',
12722
+ 'is_access_code_error',
12723
+ 'error_code',
12724
+ ],
12725
+ type: 'object',
12726
+ },
12727
+ {
12728
+ description: 'August lock is missing a keypad.',
12729
+ properties: {
12730
+ error_code: {
12731
+ description:
12732
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12733
+ enum: ['august_lock_missing_keypad'],
12734
+ type: 'string',
12735
+ },
12736
+ is_access_code_error: { enum: [true], type: 'boolean' },
12737
+ message: { type: 'string' },
12738
+ },
12739
+ required: [
12740
+ 'message',
12741
+ 'is_access_code_error',
12742
+ 'error_code',
12743
+ ],
12744
+ type: 'object',
12745
+ },
12746
+ {
12747
+ description: 'Salto site user is not subscribed.',
12748
+ properties: {
12749
+ error_code: {
12750
+ description:
12751
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12752
+ enum: ['salto_site_user_not_subscribed'],
12753
+ type: 'string',
12754
+ },
12755
+ is_access_code_error: { enum: [true], type: 'boolean' },
12756
+ message: { type: 'string' },
12757
+ },
12758
+ required: [
12759
+ 'message',
12760
+ 'is_access_code_error',
12761
+ 'error_code',
12762
+ ],
12763
+ type: 'object',
12764
+ },
12765
+ {
12766
+ description:
12767
+ 'Access code has not yet been fully moved to the device.',
12768
+ properties: {
12769
+ error_code: {
12770
+ description:
12771
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12772
+ enum: ['hubitat_device_programming_delay'],
12773
+ type: 'string',
12774
+ },
12775
+ is_access_code_error: { enum: [true], type: 'boolean' },
12776
+ message: { type: 'string' },
12777
+ },
12778
+ required: [
12779
+ 'message',
12780
+ 'is_access_code_error',
12781
+ 'error_code',
12782
+ ],
12783
+ type: 'object',
12784
+ },
12785
+ {
12786
+ description: 'No free positions available on the device.',
12787
+ properties: {
12788
+ error_code: {
12789
+ description:
12790
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12791
+ enum: ['hubitat_no_free_positions_available'],
12792
+ type: 'string',
12793
+ },
12794
+ is_access_code_error: { enum: [true], type: 'boolean' },
12795
+ message: { type: 'string' },
12796
+ },
12797
+ required: [
12798
+ 'message',
12799
+ 'is_access_code_error',
12800
+ 'error_code',
12801
+ ],
12802
+ type: 'object',
12803
+ },
12804
+ ],
11701
12805
  },
11702
12806
  {
11703
12807
  description: 'Error associated with the `device`.',
@@ -11901,20 +13005,52 @@ export default {
11901
13005
  ],
11902
13006
  },
11903
13007
  {
11904
- properties: {
11905
- error_code: { type: 'string' },
11906
- is_connected_account_error: {
11907
- enum: [true],
11908
- type: 'boolean',
13008
+ oneOf: [
13009
+ {
13010
+ description: 'Account is disconnected.',
13011
+ properties: {
13012
+ error_code: {
13013
+ description:
13014
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13015
+ enum: ['account_disconnected'],
13016
+ type: 'string',
13017
+ },
13018
+ is_connected_account_error: {
13019
+ enum: [true],
13020
+ type: 'boolean',
13021
+ },
13022
+ message: { type: 'string' },
13023
+ },
13024
+ required: [
13025
+ 'message',
13026
+ 'is_connected_account_error',
13027
+ 'error_code',
13028
+ ],
13029
+ type: 'object',
13030
+ },
13031
+ {
13032
+ description: 'Credentials provided were invalid.',
13033
+ properties: {
13034
+ error_code: {
13035
+ description:
13036
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13037
+ enum: ['invalid_credentials'],
13038
+ type: 'string',
13039
+ },
13040
+ is_connected_account_error: {
13041
+ enum: [true],
13042
+ type: 'boolean',
13043
+ },
13044
+ message: { type: 'string' },
13045
+ },
13046
+ required: [
13047
+ 'message',
13048
+ 'is_connected_account_error',
13049
+ 'error_code',
13050
+ ],
13051
+ type: 'object',
11909
13052
  },
11910
- message: { type: 'string' },
11911
- },
11912
- required: [
11913
- 'message',
11914
- 'is_connected_account_error',
11915
- 'error_code',
11916
13053
  ],
11917
- type: 'object',
11918
13054
  },
11919
13055
  ],
11920
13056
  },
@@ -11945,12 +13081,153 @@ export default {
11945
13081
  description:
11946
13082
  '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
13083
  items: {
11948
- properties: {
11949
- message: { type: 'string' },
11950
- warning_code: { type: 'string' },
11951
- },
11952
- required: ['message', 'warning_code'],
11953
- type: 'object',
13084
+ oneOf: [
13085
+ {
13086
+ description: 'Failed to set code on Smart Things device.',
13087
+ properties: {
13088
+ message: { type: 'string' },
13089
+ warning_code: {
13090
+ description:
13091
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13092
+ enum: ['smartthings_failed_to_set_access_code'],
13093
+ type: 'string',
13094
+ },
13095
+ },
13096
+ required: ['message', 'warning_code'],
13097
+ type: 'object',
13098
+ },
13099
+ {
13100
+ description: 'Duplicate access code detected.',
13101
+ properties: {
13102
+ message: { type: 'string' },
13103
+ warning_code: {
13104
+ description:
13105
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13106
+ enum: ['schlage_detected_duplicate'],
13107
+ type: 'string',
13108
+ },
13109
+ },
13110
+ required: ['message', 'warning_code'],
13111
+ type: 'object',
13112
+ },
13113
+ {
13114
+ description:
13115
+ 'Received an error when attempting to create this code.',
13116
+ properties: {
13117
+ message: { type: 'string' },
13118
+ warning_code: {
13119
+ description:
13120
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13121
+ enum: ['schlage_creation_outage'],
13122
+ type: 'string',
13123
+ },
13124
+ },
13125
+ required: ['message', 'warning_code'],
13126
+ type: 'object',
13127
+ },
13128
+ {
13129
+ description:
13130
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
13131
+ properties: {
13132
+ message: { type: 'string' },
13133
+ warning_code: {
13134
+ description:
13135
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13136
+ enum: ['code_modified_external_to_seam'],
13137
+ type: 'string',
13138
+ },
13139
+ },
13140
+ required: ['message', 'warning_code'],
13141
+ type: 'object',
13142
+ },
13143
+ {
13144
+ description: 'Delay in setting code on device.',
13145
+ properties: {
13146
+ message: { type: 'string' },
13147
+ warning_code: {
13148
+ description:
13149
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13150
+ enum: ['delay_in_setting_on_device'],
13151
+ type: 'string',
13152
+ },
13153
+ },
13154
+ required: ['message', 'warning_code'],
13155
+ type: 'object',
13156
+ },
13157
+ {
13158
+ description: 'Delay in removing code from device.',
13159
+ properties: {
13160
+ message: { type: 'string' },
13161
+ warning_code: {
13162
+ description:
13163
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13164
+ enum: ['delay_in_removing_from_device'],
13165
+ type: 'string',
13166
+ },
13167
+ },
13168
+ required: ['message', 'warning_code'],
13169
+ type: 'object',
13170
+ },
13171
+ {
13172
+ description:
13173
+ 'Third party integration detected that may cause access codes to fail.',
13174
+ properties: {
13175
+ message: { type: 'string' },
13176
+ warning_code: {
13177
+ description:
13178
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13179
+ enum: ['third_party_integration_detected'],
13180
+ type: 'string',
13181
+ },
13182
+ },
13183
+ required: ['message', 'warning_code'],
13184
+ type: 'object',
13185
+ },
13186
+ {
13187
+ description:
13188
+ 'Access code has not yet been fully moved to the device.',
13189
+ properties: {
13190
+ message: { type: 'string' },
13191
+ warning_code: {
13192
+ description:
13193
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13194
+ enum: ['august_device_programming_delay'],
13195
+ type: 'string',
13196
+ },
13197
+ },
13198
+ required: ['message', 'warning_code'],
13199
+ type: 'object',
13200
+ },
13201
+ {
13202
+ description: 'Algopins must be used within 24 hours.',
13203
+ properties: {
13204
+ message: { type: 'string' },
13205
+ warning_code: {
13206
+ description:
13207
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13208
+ enum: ['igloo_algopin_must_be_used_within_24_hours'],
13209
+ type: 'string',
13210
+ },
13211
+ },
13212
+ required: ['message', 'warning_code'],
13213
+ type: 'object',
13214
+ },
13215
+ {
13216
+ description:
13217
+ 'Management was transferred to another workspace.',
13218
+ properties: {
13219
+ message: { type: 'string' },
13220
+ warning_code: {
13221
+ description:
13222
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13223
+ enum: ['management_transferred'],
13224
+ type: 'string',
13225
+ },
13226
+ },
13227
+ required: ['message', 'warning_code'],
13228
+ type: 'object',
13229
+ },
13230
+ ],
11954
13231
  },
11955
13232
  type: 'array',
11956
13233
  },
@@ -12274,20 +13551,52 @@ export default {
12274
13551
  ],
12275
13552
  },
12276
13553
  {
12277
- properties: {
12278
- error_code: { type: 'string' },
12279
- is_connected_account_error: {
12280
- enum: [true],
12281
- type: 'boolean',
13554
+ oneOf: [
13555
+ {
13556
+ description: 'Account is disconnected.',
13557
+ properties: {
13558
+ error_code: {
13559
+ description:
13560
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13561
+ enum: ['account_disconnected'],
13562
+ type: 'string',
13563
+ },
13564
+ is_connected_account_error: {
13565
+ enum: [true],
13566
+ type: 'boolean',
13567
+ },
13568
+ message: { type: 'string' },
13569
+ },
13570
+ required: [
13571
+ 'message',
13572
+ 'is_connected_account_error',
13573
+ 'error_code',
13574
+ ],
13575
+ type: 'object',
13576
+ },
13577
+ {
13578
+ description: 'Credentials provided were invalid.',
13579
+ properties: {
13580
+ error_code: {
13581
+ description:
13582
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13583
+ enum: ['invalid_credentials'],
13584
+ type: 'string',
13585
+ },
13586
+ is_connected_account_error: {
13587
+ enum: [true],
13588
+ type: 'boolean',
13589
+ },
13590
+ message: { type: 'string' },
13591
+ },
13592
+ required: [
13593
+ 'message',
13594
+ 'is_connected_account_error',
13595
+ 'error_code',
13596
+ ],
13597
+ type: 'object',
12282
13598
  },
12283
- message: { type: 'string' },
12284
- },
12285
- required: [
12286
- 'message',
12287
- 'is_connected_account_error',
12288
- 'error_code',
12289
13599
  ],
12290
- type: 'object',
12291
13600
  },
12292
13601
  ],
12293
13602
  },
@@ -15787,6 +17096,24 @@ export default {
15787
17096
  format: 'uuid',
15788
17097
  type: 'string',
15789
17098
  },
17099
+ assa_abloy_vostio_metadata: {
17100
+ description:
17101
+ 'Vostio-specific metadata for the credential.',
17102
+ properties: {
17103
+ door_names: {
17104
+ items: { type: 'string' },
17105
+ type: 'array',
17106
+ },
17107
+ endpoint_id: { type: 'string' },
17108
+ key_id: { type: 'string' },
17109
+ key_issuing_request_id: { type: 'string' },
17110
+ override_guest_acs_entrance_ids: {
17111
+ items: { type: 'string' },
17112
+ type: 'array',
17113
+ },
17114
+ },
17115
+ type: 'object',
17116
+ },
15790
17117
  card_number: { nullable: true, type: 'string' },
15791
17118
  code: {
15792
17119
  description: 'Access (PIN) code for the credential.',
@@ -16249,6 +17576,24 @@ export default {
16249
17576
  format: 'uuid',
16250
17577
  type: 'string',
16251
17578
  },
17579
+ assa_abloy_vostio_metadata: {
17580
+ description:
17581
+ 'Vostio-specific metadata for the credential.',
17582
+ properties: {
17583
+ door_names: {
17584
+ items: { type: 'string' },
17585
+ type: 'array',
17586
+ },
17587
+ endpoint_id: { type: 'string' },
17588
+ key_id: { type: 'string' },
17589
+ key_issuing_request_id: { type: 'string' },
17590
+ override_guest_acs_entrance_ids: {
17591
+ items: { type: 'string' },
17592
+ type: 'array',
17593
+ },
17594
+ },
17595
+ type: 'object',
17596
+ },
16252
17597
  card_number: { nullable: true, type: 'string' },
16253
17598
  code: {
16254
17599
  description: