@seamapi/types 1.909.0 → 1.910.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.
- package/dist/connect.cjs +143 -1152
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +0 -2497
- package/dist/index.cjs +143 -1152
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +97 -1168
- package/lib/seam/connect/models/access-codes/managed-access-code.js +0 -229
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +0 -391
- package/lib/seam/connect/openapi.js +69 -907
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +0 -1474
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +0 -276
- package/src/lib/seam/connect/openapi.ts +182 -1158
- package/src/lib/seam/connect/route-types.ts +0 -1650
|
@@ -135,74 +135,6 @@ const openapi: OpenAPISpec = {
|
|
|
135
135
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
136
136
|
type: 'object',
|
|
137
137
|
},
|
|
138
|
-
{
|
|
139
|
-
deprecated: true,
|
|
140
|
-
description: 'Failed to set code on SmartThings device.',
|
|
141
|
-
properties: {
|
|
142
|
-
created_at: {
|
|
143
|
-
description:
|
|
144
|
-
'Date and time at which Seam created the error.',
|
|
145
|
-
format: 'date-time',
|
|
146
|
-
type: 'string',
|
|
147
|
-
},
|
|
148
|
-
error_code: {
|
|
149
|
-
description:
|
|
150
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
151
|
-
enum: ['smartthings_failed_to_set_access_code'],
|
|
152
|
-
type: 'string',
|
|
153
|
-
},
|
|
154
|
-
is_access_code_error: {
|
|
155
|
-
description:
|
|
156
|
-
'Indicates that this is an access code error.',
|
|
157
|
-
enum: [true],
|
|
158
|
-
type: 'boolean',
|
|
159
|
-
},
|
|
160
|
-
message: {
|
|
161
|
-
description:
|
|
162
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
163
|
-
type: 'string',
|
|
164
|
-
},
|
|
165
|
-
},
|
|
166
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
167
|
-
type: 'object',
|
|
168
|
-
'x-deprecated':
|
|
169
|
-
'Handled by the generic `failed_to_set_on_device` system.',
|
|
170
|
-
},
|
|
171
|
-
{
|
|
172
|
-
deprecated: true,
|
|
173
|
-
description: 'Failed to set code after multiple retries.',
|
|
174
|
-
properties: {
|
|
175
|
-
created_at: {
|
|
176
|
-
description:
|
|
177
|
-
'Date and time at which Seam created the error.',
|
|
178
|
-
format: 'date-time',
|
|
179
|
-
type: 'string',
|
|
180
|
-
},
|
|
181
|
-
error_code: {
|
|
182
|
-
description:
|
|
183
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
184
|
-
enum: [
|
|
185
|
-
'smartthings_failed_to_set_after_multiple_retries',
|
|
186
|
-
],
|
|
187
|
-
type: 'string',
|
|
188
|
-
},
|
|
189
|
-
is_access_code_error: {
|
|
190
|
-
description:
|
|
191
|
-
'Indicates that this is an access code error.',
|
|
192
|
-
enum: [true],
|
|
193
|
-
type: 'boolean',
|
|
194
|
-
},
|
|
195
|
-
message: {
|
|
196
|
-
description:
|
|
197
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
198
|
-
type: 'string',
|
|
199
|
-
},
|
|
200
|
-
},
|
|
201
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
202
|
-
type: 'object',
|
|
203
|
-
'x-deprecated':
|
|
204
|
-
'Handled by the generic `failed_to_set_on_device` system.',
|
|
205
|
-
},
|
|
206
138
|
{
|
|
207
139
|
description: 'Failed to set code on device.',
|
|
208
140
|
properties: {
|
|
@@ -397,74 +329,6 @@ const openapi: OpenAPISpec = {
|
|
|
397
329
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
398
330
|
type: 'object',
|
|
399
331
|
},
|
|
400
|
-
{
|
|
401
|
-
deprecated: true,
|
|
402
|
-
description:
|
|
403
|
-
'Unable to confirm that the access code is set on Kwikset device.',
|
|
404
|
-
properties: {
|
|
405
|
-
created_at: {
|
|
406
|
-
description:
|
|
407
|
-
'Date and time at which Seam created the error.',
|
|
408
|
-
format: 'date-time',
|
|
409
|
-
type: 'string',
|
|
410
|
-
},
|
|
411
|
-
error_code: {
|
|
412
|
-
description:
|
|
413
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
414
|
-
enum: ['kwikset_unable_to_confirm_code'],
|
|
415
|
-
type: 'string',
|
|
416
|
-
},
|
|
417
|
-
is_access_code_error: {
|
|
418
|
-
description:
|
|
419
|
-
'Indicates that this is an access code error.',
|
|
420
|
-
enum: [true],
|
|
421
|
-
type: 'boolean',
|
|
422
|
-
},
|
|
423
|
-
message: {
|
|
424
|
-
description:
|
|
425
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
426
|
-
type: 'string',
|
|
427
|
-
},
|
|
428
|
-
},
|
|
429
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
430
|
-
type: 'object',
|
|
431
|
-
'x-deprecated':
|
|
432
|
-
'Use `access_code_state_unconfirmed` instead.',
|
|
433
|
-
},
|
|
434
|
-
{
|
|
435
|
-
deprecated: true,
|
|
436
|
-
description:
|
|
437
|
-
'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
438
|
-
properties: {
|
|
439
|
-
created_at: {
|
|
440
|
-
description:
|
|
441
|
-
'Date and time at which Seam created the error.',
|
|
442
|
-
format: 'date-time',
|
|
443
|
-
type: 'string',
|
|
444
|
-
},
|
|
445
|
-
error_code: {
|
|
446
|
-
description:
|
|
447
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
448
|
-
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
449
|
-
type: 'string',
|
|
450
|
-
},
|
|
451
|
-
is_access_code_error: {
|
|
452
|
-
description:
|
|
453
|
-
'Indicates that this is an access code error.',
|
|
454
|
-
enum: [true],
|
|
455
|
-
type: 'boolean',
|
|
456
|
-
},
|
|
457
|
-
message: {
|
|
458
|
-
description:
|
|
459
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
460
|
-
type: 'string',
|
|
461
|
-
},
|
|
462
|
-
},
|
|
463
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
464
|
-
type: 'object',
|
|
465
|
-
'x-deprecated':
|
|
466
|
-
'Use `access_code_state_unconfirmed` instead.',
|
|
467
|
-
},
|
|
468
332
|
{
|
|
469
333
|
description:
|
|
470
334
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
@@ -529,8 +393,8 @@ const openapi: OpenAPISpec = {
|
|
|
529
393
|
type: 'object',
|
|
530
394
|
},
|
|
531
395
|
{
|
|
532
|
-
|
|
533
|
-
|
|
396
|
+
description:
|
|
397
|
+
'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
534
398
|
properties: {
|
|
535
399
|
created_at: {
|
|
536
400
|
description:
|
|
@@ -541,7 +405,7 @@ const openapi: OpenAPISpec = {
|
|
|
541
405
|
error_code: {
|
|
542
406
|
description:
|
|
543
407
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
544
|
-
enum: ['
|
|
408
|
+
enum: ['access_code_inactive'],
|
|
545
409
|
type: 'string',
|
|
546
410
|
},
|
|
547
411
|
is_access_code_error: {
|
|
@@ -558,11 +422,10 @@ const openapi: OpenAPISpec = {
|
|
|
558
422
|
},
|
|
559
423
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
560
424
|
type: 'object',
|
|
561
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
562
425
|
},
|
|
563
426
|
{
|
|
564
427
|
deprecated: true,
|
|
565
|
-
description: '
|
|
428
|
+
description: 'Salto site user is not subscribed.',
|
|
566
429
|
properties: {
|
|
567
430
|
created_at: {
|
|
568
431
|
description:
|
|
@@ -573,7 +436,7 @@ const openapi: OpenAPISpec = {
|
|
|
573
436
|
error_code: {
|
|
574
437
|
description:
|
|
575
438
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
576
|
-
enum: ['
|
|
439
|
+
enum: ['salto_ks_user_not_subscribed'],
|
|
577
440
|
type: 'string',
|
|
578
441
|
},
|
|
579
442
|
is_access_code_error: {
|
|
@@ -590,11 +453,11 @@ const openapi: OpenAPISpec = {
|
|
|
590
453
|
},
|
|
591
454
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
592
455
|
type: 'object',
|
|
593
|
-
'x-deprecated': 'Use `
|
|
456
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
594
457
|
},
|
|
595
458
|
{
|
|
596
|
-
|
|
597
|
-
|
|
459
|
+
description:
|
|
460
|
+
'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
|
|
598
461
|
properties: {
|
|
599
462
|
created_at: {
|
|
600
463
|
description:
|
|
@@ -605,7 +468,7 @@ const openapi: OpenAPISpec = {
|
|
|
605
468
|
error_code: {
|
|
606
469
|
description:
|
|
607
470
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
608
|
-
enum: ['
|
|
471
|
+
enum: ['insufficient_permissions'],
|
|
609
472
|
type: 'string',
|
|
610
473
|
},
|
|
611
474
|
is_access_code_error: {
|
|
@@ -622,11 +485,10 @@ const openapi: OpenAPISpec = {
|
|
|
622
485
|
},
|
|
623
486
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
624
487
|
type: 'object',
|
|
625
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
626
488
|
},
|
|
627
489
|
{
|
|
628
490
|
description:
|
|
629
|
-
'
|
|
491
|
+
'This access code was overridden on the device by a newer access code programmed to the same slot.',
|
|
630
492
|
properties: {
|
|
631
493
|
created_at: {
|
|
632
494
|
description:
|
|
@@ -637,7 +499,7 @@ const openapi: OpenAPISpec = {
|
|
|
637
499
|
error_code: {
|
|
638
500
|
description:
|
|
639
501
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
640
|
-
enum: ['
|
|
502
|
+
enum: ['replaced_by_newer_access_code'],
|
|
641
503
|
type: 'string',
|
|
642
504
|
},
|
|
643
505
|
is_access_code_error: {
|
|
@@ -656,8 +518,7 @@ const openapi: OpenAPISpec = {
|
|
|
656
518
|
type: 'object',
|
|
657
519
|
},
|
|
658
520
|
{
|
|
659
|
-
|
|
660
|
-
description: 'Salto site user is not subscribed.',
|
|
521
|
+
description: 'Indicates that the account is disconnected.',
|
|
661
522
|
properties: {
|
|
662
523
|
created_at: {
|
|
663
524
|
description:
|
|
@@ -668,28 +529,39 @@ const openapi: OpenAPISpec = {
|
|
|
668
529
|
error_code: {
|
|
669
530
|
description:
|
|
670
531
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
671
|
-
enum: ['
|
|
532
|
+
enum: ['account_disconnected'],
|
|
672
533
|
type: 'string',
|
|
673
534
|
},
|
|
674
|
-
|
|
535
|
+
is_connected_account_error: {
|
|
675
536
|
description:
|
|
676
|
-
'Indicates that
|
|
537
|
+
'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
|
|
677
538
|
enum: [true],
|
|
678
539
|
type: 'boolean',
|
|
679
540
|
},
|
|
541
|
+
is_device_error: {
|
|
542
|
+
description:
|
|
543
|
+
'Indicates that the error is not a device error.',
|
|
544
|
+
enum: [false],
|
|
545
|
+
type: 'boolean',
|
|
546
|
+
},
|
|
680
547
|
message: {
|
|
681
548
|
description:
|
|
682
549
|
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
683
550
|
type: 'string',
|
|
684
551
|
},
|
|
685
552
|
},
|
|
686
|
-
required: [
|
|
553
|
+
required: [
|
|
554
|
+
'message',
|
|
555
|
+
'is_device_error',
|
|
556
|
+
'created_at',
|
|
557
|
+
'error_code',
|
|
558
|
+
'is_connected_account_error',
|
|
559
|
+
],
|
|
687
560
|
type: 'object',
|
|
688
|
-
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
689
561
|
},
|
|
690
562
|
{
|
|
691
|
-
|
|
692
|
-
|
|
563
|
+
description:
|
|
564
|
+
'Indicates that the Salto site user limit has been reached.',
|
|
693
565
|
properties: {
|
|
694
566
|
created_at: {
|
|
695
567
|
description:
|
|
@@ -700,28 +572,40 @@ const openapi: OpenAPISpec = {
|
|
|
700
572
|
error_code: {
|
|
701
573
|
description:
|
|
702
574
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
703
|
-
enum: ['
|
|
575
|
+
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
704
576
|
type: 'string',
|
|
705
577
|
},
|
|
706
|
-
|
|
578
|
+
is_connected_account_error: {
|
|
707
579
|
description:
|
|
708
|
-
'Indicates that
|
|
580
|
+
'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
|
|
709
581
|
enum: [true],
|
|
710
582
|
type: 'boolean',
|
|
711
583
|
},
|
|
584
|
+
is_device_error: {
|
|
585
|
+
description:
|
|
586
|
+
'Indicates that the error is not a device error.',
|
|
587
|
+
enum: [false],
|
|
588
|
+
type: 'boolean',
|
|
589
|
+
},
|
|
712
590
|
message: {
|
|
713
591
|
description:
|
|
714
592
|
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
715
593
|
type: 'string',
|
|
716
594
|
},
|
|
717
595
|
},
|
|
718
|
-
required: [
|
|
596
|
+
required: [
|
|
597
|
+
'message',
|
|
598
|
+
'is_device_error',
|
|
599
|
+
'created_at',
|
|
600
|
+
'error_code',
|
|
601
|
+
'is_connected_account_error',
|
|
602
|
+
],
|
|
719
603
|
type: 'object',
|
|
720
|
-
'x-
|
|
604
|
+
'x-variant-group-key': 'locks',
|
|
721
605
|
},
|
|
722
606
|
{
|
|
723
607
|
deprecated: true,
|
|
724
|
-
description: '
|
|
608
|
+
description: 'Indicates that the device is offline.',
|
|
725
609
|
properties: {
|
|
726
610
|
created_at: {
|
|
727
611
|
description:
|
|
@@ -732,12 +616,12 @@ const openapi: OpenAPISpec = {
|
|
|
732
616
|
error_code: {
|
|
733
617
|
description:
|
|
734
618
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
735
|
-
enum: ['
|
|
619
|
+
enum: ['device_offline'],
|
|
736
620
|
type: 'string',
|
|
737
621
|
},
|
|
738
|
-
|
|
622
|
+
is_device_error: {
|
|
739
623
|
description:
|
|
740
|
-
'Indicates that
|
|
624
|
+
'Indicates that the error is a device error.',
|
|
741
625
|
enum: [true],
|
|
742
626
|
type: 'boolean',
|
|
743
627
|
},
|
|
@@ -747,14 +631,17 @@ const openapi: OpenAPISpec = {
|
|
|
747
631
|
type: 'string',
|
|
748
632
|
},
|
|
749
633
|
},
|
|
750
|
-
required: [
|
|
634
|
+
required: [
|
|
635
|
+
'message',
|
|
636
|
+
'is_device_error',
|
|
637
|
+
'created_at',
|
|
638
|
+
'error_code',
|
|
639
|
+
],
|
|
751
640
|
type: 'object',
|
|
752
|
-
'x-deprecated': 'Use `
|
|
641
|
+
'x-deprecated': 'Use `device_disconnected` instead.',
|
|
753
642
|
},
|
|
754
643
|
{
|
|
755
|
-
|
|
756
|
-
description:
|
|
757
|
-
'No Dormakaba Oracode user levels configured for the requested time range.',
|
|
644
|
+
description: 'Indicates that the device has been removed.',
|
|
758
645
|
properties: {
|
|
759
646
|
created_at: {
|
|
760
647
|
description:
|
|
@@ -765,12 +652,12 @@ const openapi: OpenAPISpec = {
|
|
|
765
652
|
error_code: {
|
|
766
653
|
description:
|
|
767
654
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
768
|
-
enum: ['
|
|
655
|
+
enum: ['device_removed'],
|
|
769
656
|
type: 'string',
|
|
770
657
|
},
|
|
771
|
-
|
|
658
|
+
is_device_error: {
|
|
772
659
|
description:
|
|
773
|
-
'Indicates that
|
|
660
|
+
'Indicates that the error is a device error.',
|
|
774
661
|
enum: [true],
|
|
775
662
|
type: 'boolean',
|
|
776
663
|
},
|
|
@@ -780,13 +667,16 @@ const openapi: OpenAPISpec = {
|
|
|
780
667
|
type: 'string',
|
|
781
668
|
},
|
|
782
669
|
},
|
|
783
|
-
required: [
|
|
670
|
+
required: [
|
|
671
|
+
'message',
|
|
672
|
+
'is_device_error',
|
|
673
|
+
'created_at',
|
|
674
|
+
'error_code',
|
|
675
|
+
],
|
|
784
676
|
type: 'object',
|
|
785
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
786
677
|
},
|
|
787
678
|
{
|
|
788
|
-
description:
|
|
789
|
-
'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
|
|
679
|
+
description: 'Indicates that the hub is disconnected.',
|
|
790
680
|
properties: {
|
|
791
681
|
created_at: {
|
|
792
682
|
description:
|
|
@@ -797,12 +687,12 @@ const openapi: OpenAPISpec = {
|
|
|
797
687
|
error_code: {
|
|
798
688
|
description:
|
|
799
689
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
800
|
-
enum: ['
|
|
690
|
+
enum: ['hub_disconnected'],
|
|
801
691
|
type: 'string',
|
|
802
692
|
},
|
|
803
|
-
|
|
693
|
+
is_device_error: {
|
|
804
694
|
description:
|
|
805
|
-
'Indicates that
|
|
695
|
+
'Indicates that the error is a device error.',
|
|
806
696
|
enum: [true],
|
|
807
697
|
type: 'boolean',
|
|
808
698
|
},
|
|
@@ -812,12 +702,16 @@ const openapi: OpenAPISpec = {
|
|
|
812
702
|
type: 'string',
|
|
813
703
|
},
|
|
814
704
|
},
|
|
815
|
-
required: [
|
|
705
|
+
required: [
|
|
706
|
+
'message',
|
|
707
|
+
'is_device_error',
|
|
708
|
+
'created_at',
|
|
709
|
+
'error_code',
|
|
710
|
+
],
|
|
816
711
|
type: 'object',
|
|
817
712
|
},
|
|
818
713
|
{
|
|
819
|
-
|
|
820
|
-
description: 'KeyNest locker is not supported.',
|
|
714
|
+
description: 'Indicates that the device is disconnected.',
|
|
821
715
|
properties: {
|
|
822
716
|
created_at: {
|
|
823
717
|
description:
|
|
@@ -828,12 +722,12 @@ const openapi: OpenAPISpec = {
|
|
|
828
722
|
error_code: {
|
|
829
723
|
description:
|
|
830
724
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
831
|
-
enum: ['
|
|
725
|
+
enum: ['device_disconnected'],
|
|
832
726
|
type: 'string',
|
|
833
727
|
},
|
|
834
|
-
|
|
728
|
+
is_device_error: {
|
|
835
729
|
description:
|
|
836
|
-
'Indicates that
|
|
730
|
+
'Indicates that the error is a device error.',
|
|
837
731
|
enum: [true],
|
|
838
732
|
type: 'boolean',
|
|
839
733
|
},
|
|
@@ -843,13 +737,17 @@ const openapi: OpenAPISpec = {
|
|
|
843
737
|
type: 'string',
|
|
844
738
|
},
|
|
845
739
|
},
|
|
846
|
-
required: [
|
|
740
|
+
required: [
|
|
741
|
+
'message',
|
|
742
|
+
'is_device_error',
|
|
743
|
+
'created_at',
|
|
744
|
+
'error_code',
|
|
745
|
+
],
|
|
847
746
|
type: 'object',
|
|
848
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
849
747
|
},
|
|
850
748
|
{
|
|
851
749
|
description:
|
|
852
|
-
'
|
|
750
|
+
'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.',
|
|
853
751
|
properties: {
|
|
854
752
|
created_at: {
|
|
855
753
|
description:
|
|
@@ -860,271 +758,12 @@ const openapi: OpenAPISpec = {
|
|
|
860
758
|
error_code: {
|
|
861
759
|
description:
|
|
862
760
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
863
|
-
enum: ['
|
|
761
|
+
enum: ['empty_backup_access_code_pool'],
|
|
864
762
|
type: 'string',
|
|
865
763
|
},
|
|
866
|
-
|
|
764
|
+
is_device_error: {
|
|
867
765
|
description:
|
|
868
|
-
'Indicates that
|
|
869
|
-
enum: [true],
|
|
870
|
-
type: 'boolean',
|
|
871
|
-
},
|
|
872
|
-
message: {
|
|
873
|
-
description:
|
|
874
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
875
|
-
type: 'string',
|
|
876
|
-
},
|
|
877
|
-
},
|
|
878
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
879
|
-
type: 'object',
|
|
880
|
-
},
|
|
881
|
-
{
|
|
882
|
-
description: 'Indicates that the account is disconnected.',
|
|
883
|
-
properties: {
|
|
884
|
-
created_at: {
|
|
885
|
-
description:
|
|
886
|
-
'Date and time at which Seam created the error.',
|
|
887
|
-
format: 'date-time',
|
|
888
|
-
type: 'string',
|
|
889
|
-
},
|
|
890
|
-
error_code: {
|
|
891
|
-
description:
|
|
892
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
893
|
-
enum: ['account_disconnected'],
|
|
894
|
-
type: 'string',
|
|
895
|
-
},
|
|
896
|
-
is_connected_account_error: {
|
|
897
|
-
description:
|
|
898
|
-
'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
|
|
899
|
-
enum: [true],
|
|
900
|
-
type: 'boolean',
|
|
901
|
-
},
|
|
902
|
-
is_device_error: {
|
|
903
|
-
description:
|
|
904
|
-
'Indicates that the error is not a device error.',
|
|
905
|
-
enum: [false],
|
|
906
|
-
type: 'boolean',
|
|
907
|
-
},
|
|
908
|
-
message: {
|
|
909
|
-
description:
|
|
910
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
911
|
-
type: 'string',
|
|
912
|
-
},
|
|
913
|
-
},
|
|
914
|
-
required: [
|
|
915
|
-
'message',
|
|
916
|
-
'is_device_error',
|
|
917
|
-
'created_at',
|
|
918
|
-
'error_code',
|
|
919
|
-
'is_connected_account_error',
|
|
920
|
-
],
|
|
921
|
-
type: 'object',
|
|
922
|
-
},
|
|
923
|
-
{
|
|
924
|
-
description:
|
|
925
|
-
'Indicates that the Salto site user limit has been reached.',
|
|
926
|
-
properties: {
|
|
927
|
-
created_at: {
|
|
928
|
-
description:
|
|
929
|
-
'Date and time at which Seam created the error.',
|
|
930
|
-
format: 'date-time',
|
|
931
|
-
type: 'string',
|
|
932
|
-
},
|
|
933
|
-
error_code: {
|
|
934
|
-
description:
|
|
935
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
936
|
-
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
937
|
-
type: 'string',
|
|
938
|
-
},
|
|
939
|
-
is_connected_account_error: {
|
|
940
|
-
description:
|
|
941
|
-
'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
|
|
942
|
-
enum: [true],
|
|
943
|
-
type: 'boolean',
|
|
944
|
-
},
|
|
945
|
-
is_device_error: {
|
|
946
|
-
description:
|
|
947
|
-
'Indicates that the error is not a device error.',
|
|
948
|
-
enum: [false],
|
|
949
|
-
type: 'boolean',
|
|
950
|
-
},
|
|
951
|
-
message: {
|
|
952
|
-
description:
|
|
953
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
954
|
-
type: 'string',
|
|
955
|
-
},
|
|
956
|
-
},
|
|
957
|
-
required: [
|
|
958
|
-
'message',
|
|
959
|
-
'is_device_error',
|
|
960
|
-
'created_at',
|
|
961
|
-
'error_code',
|
|
962
|
-
'is_connected_account_error',
|
|
963
|
-
],
|
|
964
|
-
type: 'object',
|
|
965
|
-
'x-variant-group-key': 'locks',
|
|
966
|
-
},
|
|
967
|
-
{
|
|
968
|
-
deprecated: true,
|
|
969
|
-
description: 'Indicates that the device is offline.',
|
|
970
|
-
properties: {
|
|
971
|
-
created_at: {
|
|
972
|
-
description:
|
|
973
|
-
'Date and time at which Seam created the error.',
|
|
974
|
-
format: 'date-time',
|
|
975
|
-
type: 'string',
|
|
976
|
-
},
|
|
977
|
-
error_code: {
|
|
978
|
-
description:
|
|
979
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
980
|
-
enum: ['device_offline'],
|
|
981
|
-
type: 'string',
|
|
982
|
-
},
|
|
983
|
-
is_device_error: {
|
|
984
|
-
description:
|
|
985
|
-
'Indicates that the error is a device error.',
|
|
986
|
-
enum: [true],
|
|
987
|
-
type: 'boolean',
|
|
988
|
-
},
|
|
989
|
-
message: {
|
|
990
|
-
description:
|
|
991
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
992
|
-
type: 'string',
|
|
993
|
-
},
|
|
994
|
-
},
|
|
995
|
-
required: [
|
|
996
|
-
'message',
|
|
997
|
-
'is_device_error',
|
|
998
|
-
'created_at',
|
|
999
|
-
'error_code',
|
|
1000
|
-
],
|
|
1001
|
-
type: 'object',
|
|
1002
|
-
'x-deprecated': 'Use `device_disconnected` instead.',
|
|
1003
|
-
},
|
|
1004
|
-
{
|
|
1005
|
-
description: 'Indicates that the device has been removed.',
|
|
1006
|
-
properties: {
|
|
1007
|
-
created_at: {
|
|
1008
|
-
description:
|
|
1009
|
-
'Date and time at which Seam created the error.',
|
|
1010
|
-
format: 'date-time',
|
|
1011
|
-
type: 'string',
|
|
1012
|
-
},
|
|
1013
|
-
error_code: {
|
|
1014
|
-
description:
|
|
1015
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
1016
|
-
enum: ['device_removed'],
|
|
1017
|
-
type: 'string',
|
|
1018
|
-
},
|
|
1019
|
-
is_device_error: {
|
|
1020
|
-
description:
|
|
1021
|
-
'Indicates that the error is a device error.',
|
|
1022
|
-
enum: [true],
|
|
1023
|
-
type: 'boolean',
|
|
1024
|
-
},
|
|
1025
|
-
message: {
|
|
1026
|
-
description:
|
|
1027
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1028
|
-
type: 'string',
|
|
1029
|
-
},
|
|
1030
|
-
},
|
|
1031
|
-
required: [
|
|
1032
|
-
'message',
|
|
1033
|
-
'is_device_error',
|
|
1034
|
-
'created_at',
|
|
1035
|
-
'error_code',
|
|
1036
|
-
],
|
|
1037
|
-
type: 'object',
|
|
1038
|
-
},
|
|
1039
|
-
{
|
|
1040
|
-
description: 'Indicates that the hub is disconnected.',
|
|
1041
|
-
properties: {
|
|
1042
|
-
created_at: {
|
|
1043
|
-
description:
|
|
1044
|
-
'Date and time at which Seam created the error.',
|
|
1045
|
-
format: 'date-time',
|
|
1046
|
-
type: 'string',
|
|
1047
|
-
},
|
|
1048
|
-
error_code: {
|
|
1049
|
-
description:
|
|
1050
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
1051
|
-
enum: ['hub_disconnected'],
|
|
1052
|
-
type: 'string',
|
|
1053
|
-
},
|
|
1054
|
-
is_device_error: {
|
|
1055
|
-
description:
|
|
1056
|
-
'Indicates that the error is a device error.',
|
|
1057
|
-
enum: [true],
|
|
1058
|
-
type: 'boolean',
|
|
1059
|
-
},
|
|
1060
|
-
message: {
|
|
1061
|
-
description:
|
|
1062
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1063
|
-
type: 'string',
|
|
1064
|
-
},
|
|
1065
|
-
},
|
|
1066
|
-
required: [
|
|
1067
|
-
'message',
|
|
1068
|
-
'is_device_error',
|
|
1069
|
-
'created_at',
|
|
1070
|
-
'error_code',
|
|
1071
|
-
],
|
|
1072
|
-
type: 'object',
|
|
1073
|
-
},
|
|
1074
|
-
{
|
|
1075
|
-
description: 'Indicates that the device is disconnected.',
|
|
1076
|
-
properties: {
|
|
1077
|
-
created_at: {
|
|
1078
|
-
description:
|
|
1079
|
-
'Date and time at which Seam created the error.',
|
|
1080
|
-
format: 'date-time',
|
|
1081
|
-
type: 'string',
|
|
1082
|
-
},
|
|
1083
|
-
error_code: {
|
|
1084
|
-
description:
|
|
1085
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
1086
|
-
enum: ['device_disconnected'],
|
|
1087
|
-
type: 'string',
|
|
1088
|
-
},
|
|
1089
|
-
is_device_error: {
|
|
1090
|
-
description:
|
|
1091
|
-
'Indicates that the error is a device error.',
|
|
1092
|
-
enum: [true],
|
|
1093
|
-
type: 'boolean',
|
|
1094
|
-
},
|
|
1095
|
-
message: {
|
|
1096
|
-
description:
|
|
1097
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1098
|
-
type: 'string',
|
|
1099
|
-
},
|
|
1100
|
-
},
|
|
1101
|
-
required: [
|
|
1102
|
-
'message',
|
|
1103
|
-
'is_device_error',
|
|
1104
|
-
'created_at',
|
|
1105
|
-
'error_code',
|
|
1106
|
-
],
|
|
1107
|
-
type: 'object',
|
|
1108
|
-
},
|
|
1109
|
-
{
|
|
1110
|
-
description:
|
|
1111
|
-
'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.',
|
|
1112
|
-
properties: {
|
|
1113
|
-
created_at: {
|
|
1114
|
-
description:
|
|
1115
|
-
'Date and time at which Seam created the error.',
|
|
1116
|
-
format: 'date-time',
|
|
1117
|
-
type: 'string',
|
|
1118
|
-
},
|
|
1119
|
-
error_code: {
|
|
1120
|
-
description:
|
|
1121
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
1122
|
-
enum: ['empty_backup_access_code_pool'],
|
|
1123
|
-
type: 'string',
|
|
1124
|
-
},
|
|
1125
|
-
is_device_error: {
|
|
1126
|
-
description:
|
|
1127
|
-
'Indicates that the error is a device error.',
|
|
766
|
+
'Indicates that the error is a device error.',
|
|
1128
767
|
enum: [true],
|
|
1129
768
|
type: 'boolean',
|
|
1130
769
|
},
|
|
@@ -1859,30 +1498,6 @@ const openapi: OpenAPISpec = {
|
|
|
1859
1498
|
required: ['message', 'warning_code'],
|
|
1860
1499
|
type: 'object',
|
|
1861
1500
|
},
|
|
1862
|
-
{
|
|
1863
|
-
description: 'Failed to set code on SmartThings device.',
|
|
1864
|
-
properties: {
|
|
1865
|
-
created_at: {
|
|
1866
|
-
description:
|
|
1867
|
-
'Date and time at which Seam created the warning.',
|
|
1868
|
-
format: 'date-time',
|
|
1869
|
-
type: 'string',
|
|
1870
|
-
},
|
|
1871
|
-
message: {
|
|
1872
|
-
description:
|
|
1873
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1874
|
-
type: 'string',
|
|
1875
|
-
},
|
|
1876
|
-
warning_code: {
|
|
1877
|
-
description:
|
|
1878
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1879
|
-
enum: ['smartthings_failed_to_set_access_code'],
|
|
1880
|
-
type: 'string',
|
|
1881
|
-
},
|
|
1882
|
-
},
|
|
1883
|
-
required: ['message', 'warning_code'],
|
|
1884
|
-
type: 'object',
|
|
1885
|
-
},
|
|
1886
1501
|
{
|
|
1887
1502
|
deprecated: true,
|
|
1888
1503
|
description: 'Duplicate access code detected.',
|
|
@@ -1910,33 +1525,6 @@ const openapi: OpenAPISpec = {
|
|
|
1910
1525
|
'x-deprecated':
|
|
1911
1526
|
'Use `duplicate_code_on_device` error instead.',
|
|
1912
1527
|
},
|
|
1913
|
-
{
|
|
1914
|
-
deprecated: true,
|
|
1915
|
-
description:
|
|
1916
|
-
'Received an error when attempting to create this code.',
|
|
1917
|
-
properties: {
|
|
1918
|
-
created_at: {
|
|
1919
|
-
description:
|
|
1920
|
-
'Date and time at which Seam created the warning.',
|
|
1921
|
-
format: 'date-time',
|
|
1922
|
-
type: 'string',
|
|
1923
|
-
},
|
|
1924
|
-
message: {
|
|
1925
|
-
description:
|
|
1926
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1927
|
-
type: 'string',
|
|
1928
|
-
},
|
|
1929
|
-
warning_code: {
|
|
1930
|
-
description:
|
|
1931
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1932
|
-
enum: ['schlage_creation_outage'],
|
|
1933
|
-
type: 'string',
|
|
1934
|
-
},
|
|
1935
|
-
},
|
|
1936
|
-
required: ['message', 'warning_code'],
|
|
1937
|
-
type: 'object',
|
|
1938
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
1939
|
-
},
|
|
1940
1528
|
{
|
|
1941
1529
|
description:
|
|
1942
1530
|
"The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|
|
@@ -2092,30 +1680,6 @@ const openapi: OpenAPISpec = {
|
|
|
2092
1680
|
required: ['message', 'warning_code'],
|
|
2093
1681
|
type: 'object',
|
|
2094
1682
|
},
|
|
2095
|
-
{
|
|
2096
|
-
description: 'August lock is temporarily offline.',
|
|
2097
|
-
properties: {
|
|
2098
|
-
created_at: {
|
|
2099
|
-
description:
|
|
2100
|
-
'Date and time at which Seam created the warning.',
|
|
2101
|
-
format: 'date-time',
|
|
2102
|
-
type: 'string',
|
|
2103
|
-
},
|
|
2104
|
-
message: {
|
|
2105
|
-
description:
|
|
2106
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2107
|
-
type: 'string',
|
|
2108
|
-
},
|
|
2109
|
-
warning_code: {
|
|
2110
|
-
description:
|
|
2111
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
2112
|
-
enum: ['august_lock_temporarily_offline'],
|
|
2113
|
-
type: 'string',
|
|
2114
|
-
},
|
|
2115
|
-
},
|
|
2116
|
-
required: ['message', 'warning_code'],
|
|
2117
|
-
type: 'object',
|
|
2118
|
-
},
|
|
2119
1683
|
{
|
|
2120
1684
|
description: 'Algopins must be used within 24 hours.',
|
|
2121
1685
|
properties: {
|
|
@@ -2165,31 +1729,6 @@ const openapi: OpenAPISpec = {
|
|
|
2165
1729
|
required: ['message', 'warning_code'],
|
|
2166
1730
|
type: 'object',
|
|
2167
1731
|
},
|
|
2168
|
-
{
|
|
2169
|
-
description:
|
|
2170
|
-
'Unable to confirm that the access code is set on Kwikset device.',
|
|
2171
|
-
properties: {
|
|
2172
|
-
created_at: {
|
|
2173
|
-
description:
|
|
2174
|
-
'Date and time at which Seam created the warning.',
|
|
2175
|
-
format: 'date-time',
|
|
2176
|
-
type: 'string',
|
|
2177
|
-
},
|
|
2178
|
-
message: {
|
|
2179
|
-
description:
|
|
2180
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2181
|
-
type: 'string',
|
|
2182
|
-
},
|
|
2183
|
-
warning_code: {
|
|
2184
|
-
description:
|
|
2185
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
2186
|
-
enum: ['kwikset_unable_to_confirm_code'],
|
|
2187
|
-
type: 'string',
|
|
2188
|
-
},
|
|
2189
|
-
},
|
|
2190
|
-
required: ['message', 'warning_code'],
|
|
2191
|
-
type: 'object',
|
|
2192
|
-
},
|
|
2193
1732
|
{
|
|
2194
1733
|
description:
|
|
2195
1734
|
'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
@@ -2215,33 +1754,6 @@ const openapi: OpenAPISpec = {
|
|
|
2215
1754
|
required: ['message', 'warning_code'],
|
|
2216
1755
|
type: 'object',
|
|
2217
1756
|
},
|
|
2218
|
-
{
|
|
2219
|
-
deprecated: true,
|
|
2220
|
-
description:
|
|
2221
|
-
'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
|
|
2222
|
-
properties: {
|
|
2223
|
-
created_at: {
|
|
2224
|
-
description:
|
|
2225
|
-
'Date and time at which Seam created the warning.',
|
|
2226
|
-
format: 'date-time',
|
|
2227
|
-
type: 'string',
|
|
2228
|
-
},
|
|
2229
|
-
message: {
|
|
2230
|
-
description:
|
|
2231
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2232
|
-
type: 'string',
|
|
2233
|
-
},
|
|
2234
|
-
warning_code: {
|
|
2235
|
-
description:
|
|
2236
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
2237
|
-
enum: ['ultraloq_access_code_disabled'],
|
|
2238
|
-
type: 'string',
|
|
2239
|
-
},
|
|
2240
|
-
},
|
|
2241
|
-
required: ['message', 'warning_code'],
|
|
2242
|
-
type: 'object',
|
|
2243
|
-
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
2244
|
-
},
|
|
2245
1757
|
{
|
|
2246
1758
|
description:
|
|
2247
1759
|
'A backup access code has been pulled and is being used in place of this access code.',
|
|
@@ -28491,396 +28003,29 @@ const openapi: OpenAPISpec = {
|
|
|
28491
28003
|
description:
|
|
28492
28004
|
'Dormakaba Oracode user level name associated with this access code.',
|
|
28493
28005
|
nullable: true,
|
|
28494
|
-
type: 'string',
|
|
28495
|
-
},
|
|
28496
|
-
},
|
|
28497
|
-
required: ['stay_id', 'user_level_name'],
|
|
28498
|
-
type: 'object',
|
|
28499
|
-
},
|
|
28500
|
-
ends_at: {
|
|
28501
|
-
description:
|
|
28502
|
-
'Date and time after which the time-bound access code becomes inactive.',
|
|
28503
|
-
format: 'date-time',
|
|
28504
|
-
nullable: true,
|
|
28505
|
-
type: 'string',
|
|
28506
|
-
},
|
|
28507
|
-
errors: {
|
|
28508
|
-
description:
|
|
28509
|
-
'Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).',
|
|
28510
|
-
items: {
|
|
28511
|
-
discriminator: { propertyName: 'error_code' },
|
|
28512
|
-
oneOf: [
|
|
28513
|
-
{
|
|
28514
|
-
description:
|
|
28515
|
-
'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
|
|
28516
|
-
properties: {
|
|
28517
|
-
created_at: {
|
|
28518
|
-
description:
|
|
28519
|
-
'Date and time at which Seam created the error.',
|
|
28520
|
-
format: 'date-time',
|
|
28521
|
-
type: 'string',
|
|
28522
|
-
},
|
|
28523
|
-
error_code: {
|
|
28524
|
-
description:
|
|
28525
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28526
|
-
enum: ['provider_issue'],
|
|
28527
|
-
type: 'string',
|
|
28528
|
-
},
|
|
28529
|
-
is_access_code_error: {
|
|
28530
|
-
description:
|
|
28531
|
-
'Indicates that this is an access code error.',
|
|
28532
|
-
enum: [true],
|
|
28533
|
-
type: 'boolean',
|
|
28534
|
-
},
|
|
28535
|
-
message: {
|
|
28536
|
-
description:
|
|
28537
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28538
|
-
type: 'string',
|
|
28539
|
-
},
|
|
28540
|
-
},
|
|
28541
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28542
|
-
type: 'object',
|
|
28543
|
-
},
|
|
28544
|
-
{
|
|
28545
|
-
deprecated: true,
|
|
28546
|
-
description: 'Failed to set code on SmartThings device.',
|
|
28547
|
-
properties: {
|
|
28548
|
-
created_at: {
|
|
28549
|
-
description:
|
|
28550
|
-
'Date and time at which Seam created the error.',
|
|
28551
|
-
format: 'date-time',
|
|
28552
|
-
type: 'string',
|
|
28553
|
-
},
|
|
28554
|
-
error_code: {
|
|
28555
|
-
description:
|
|
28556
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28557
|
-
enum: ['smartthings_failed_to_set_access_code'],
|
|
28558
|
-
type: 'string',
|
|
28559
|
-
},
|
|
28560
|
-
is_access_code_error: {
|
|
28561
|
-
description:
|
|
28562
|
-
'Indicates that this is an access code error.',
|
|
28563
|
-
enum: [true],
|
|
28564
|
-
type: 'boolean',
|
|
28565
|
-
},
|
|
28566
|
-
message: {
|
|
28567
|
-
description:
|
|
28568
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28569
|
-
type: 'string',
|
|
28570
|
-
},
|
|
28571
|
-
},
|
|
28572
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28573
|
-
type: 'object',
|
|
28574
|
-
'x-deprecated':
|
|
28575
|
-
'Handled by the generic `failed_to_set_on_device` system.',
|
|
28576
|
-
},
|
|
28577
|
-
{
|
|
28578
|
-
deprecated: true,
|
|
28579
|
-
description: 'Failed to set code after multiple retries.',
|
|
28580
|
-
properties: {
|
|
28581
|
-
created_at: {
|
|
28582
|
-
description:
|
|
28583
|
-
'Date and time at which Seam created the error.',
|
|
28584
|
-
format: 'date-time',
|
|
28585
|
-
type: 'string',
|
|
28586
|
-
},
|
|
28587
|
-
error_code: {
|
|
28588
|
-
description:
|
|
28589
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28590
|
-
enum: [
|
|
28591
|
-
'smartthings_failed_to_set_after_multiple_retries',
|
|
28592
|
-
],
|
|
28593
|
-
type: 'string',
|
|
28594
|
-
},
|
|
28595
|
-
is_access_code_error: {
|
|
28596
|
-
description:
|
|
28597
|
-
'Indicates that this is an access code error.',
|
|
28598
|
-
enum: [true],
|
|
28599
|
-
type: 'boolean',
|
|
28600
|
-
},
|
|
28601
|
-
message: {
|
|
28602
|
-
description:
|
|
28603
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28604
|
-
type: 'string',
|
|
28605
|
-
},
|
|
28606
|
-
},
|
|
28607
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28608
|
-
type: 'object',
|
|
28609
|
-
'x-deprecated':
|
|
28610
|
-
'Handled by the generic `failed_to_set_on_device` system.',
|
|
28611
|
-
},
|
|
28612
|
-
{
|
|
28613
|
-
description: 'Failed to set code on device.',
|
|
28614
|
-
properties: {
|
|
28615
|
-
created_at: {
|
|
28616
|
-
description:
|
|
28617
|
-
'Date and time at which Seam created the error.',
|
|
28618
|
-
format: 'date-time',
|
|
28619
|
-
type: 'string',
|
|
28620
|
-
},
|
|
28621
|
-
error_code: {
|
|
28622
|
-
description:
|
|
28623
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28624
|
-
enum: ['failed_to_set_on_device'],
|
|
28625
|
-
type: 'string',
|
|
28626
|
-
},
|
|
28627
|
-
is_access_code_error: {
|
|
28628
|
-
description:
|
|
28629
|
-
'Indicates that this is an access code error.',
|
|
28630
|
-
enum: [true],
|
|
28631
|
-
type: 'boolean',
|
|
28632
|
-
},
|
|
28633
|
-
message: {
|
|
28634
|
-
description:
|
|
28635
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28636
|
-
type: 'string',
|
|
28637
|
-
},
|
|
28638
|
-
},
|
|
28639
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28640
|
-
type: 'object',
|
|
28641
|
-
},
|
|
28642
|
-
{
|
|
28643
|
-
description: 'Failed to remove code from device.',
|
|
28644
|
-
properties: {
|
|
28645
|
-
created_at: {
|
|
28646
|
-
description:
|
|
28647
|
-
'Date and time at which Seam created the error.',
|
|
28648
|
-
format: 'date-time',
|
|
28649
|
-
type: 'string',
|
|
28650
|
-
},
|
|
28651
|
-
error_code: {
|
|
28652
|
-
description:
|
|
28653
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28654
|
-
enum: ['failed_to_remove_from_device'],
|
|
28655
|
-
type: 'string',
|
|
28656
|
-
},
|
|
28657
|
-
is_access_code_error: {
|
|
28658
|
-
description:
|
|
28659
|
-
'Indicates that this is an access code error.',
|
|
28660
|
-
enum: [true],
|
|
28661
|
-
type: 'boolean',
|
|
28662
|
-
},
|
|
28663
|
-
message: {
|
|
28664
|
-
description:
|
|
28665
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28666
|
-
type: 'string',
|
|
28667
|
-
},
|
|
28668
|
-
},
|
|
28669
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28670
|
-
type: 'object',
|
|
28671
|
-
},
|
|
28672
|
-
{
|
|
28673
|
-
description: 'Duplicate access code detected on device.',
|
|
28674
|
-
properties: {
|
|
28675
|
-
created_at: {
|
|
28676
|
-
description:
|
|
28677
|
-
'Date and time at which Seam created the error.',
|
|
28678
|
-
format: 'date-time',
|
|
28679
|
-
type: 'string',
|
|
28680
|
-
},
|
|
28681
|
-
error_code: {
|
|
28682
|
-
description:
|
|
28683
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28684
|
-
enum: ['duplicate_code_on_device'],
|
|
28685
|
-
type: 'string',
|
|
28686
|
-
},
|
|
28687
|
-
is_access_code_error: {
|
|
28688
|
-
description:
|
|
28689
|
-
'Indicates that this is an access code error.',
|
|
28690
|
-
enum: [true],
|
|
28691
|
-
type: 'boolean',
|
|
28692
|
-
},
|
|
28693
|
-
managed_access_code_id: {
|
|
28694
|
-
description:
|
|
28695
|
-
'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.',
|
|
28696
|
-
format: 'uuid',
|
|
28697
|
-
type: 'string',
|
|
28698
|
-
},
|
|
28699
|
-
message: {
|
|
28700
|
-
description:
|
|
28701
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28702
|
-
type: 'string',
|
|
28703
|
-
},
|
|
28704
|
-
unmanaged_access_code_id: {
|
|
28705
|
-
description:
|
|
28706
|
-
'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.',
|
|
28707
|
-
format: 'uuid',
|
|
28708
|
-
type: 'string',
|
|
28709
|
-
},
|
|
28710
|
-
},
|
|
28711
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28712
|
-
type: 'object',
|
|
28713
|
-
},
|
|
28714
|
-
{
|
|
28715
|
-
description:
|
|
28716
|
-
'An attempt to modify this access code was prevented.',
|
|
28717
|
-
properties: {
|
|
28718
|
-
created_at: {
|
|
28719
|
-
description:
|
|
28720
|
-
'Date and time at which Seam created the error.',
|
|
28721
|
-
format: 'date-time',
|
|
28722
|
-
type: 'string',
|
|
28723
|
-
},
|
|
28724
|
-
error_code: {
|
|
28725
|
-
description:
|
|
28726
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28727
|
-
enum: ['duplicate_code_attempt_prevented'],
|
|
28728
|
-
type: 'string',
|
|
28729
|
-
},
|
|
28730
|
-
is_access_code_error: {
|
|
28731
|
-
description:
|
|
28732
|
-
'Indicates that this is an access code error.',
|
|
28733
|
-
enum: [true],
|
|
28734
|
-
type: 'boolean',
|
|
28735
|
-
},
|
|
28736
|
-
message: {
|
|
28737
|
-
description:
|
|
28738
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28739
|
-
type: 'string',
|
|
28740
|
-
},
|
|
28741
|
-
},
|
|
28742
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28743
|
-
type: 'object',
|
|
28744
|
-
},
|
|
28745
|
-
{
|
|
28746
|
-
description: 'No space for access code on device.',
|
|
28747
|
-
properties: {
|
|
28748
|
-
created_at: {
|
|
28749
|
-
description:
|
|
28750
|
-
'Date and time at which Seam created the error.',
|
|
28751
|
-
format: 'date-time',
|
|
28752
|
-
type: 'string',
|
|
28753
|
-
},
|
|
28754
|
-
error_code: {
|
|
28755
|
-
description:
|
|
28756
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28757
|
-
enum: ['no_space_for_access_code_on_device'],
|
|
28758
|
-
type: 'string',
|
|
28759
|
-
},
|
|
28760
|
-
is_access_code_error: {
|
|
28761
|
-
description:
|
|
28762
|
-
'Indicates that this is an access code error.',
|
|
28763
|
-
enum: [true],
|
|
28764
|
-
type: 'boolean',
|
|
28765
|
-
},
|
|
28766
|
-
message: {
|
|
28767
|
-
description:
|
|
28768
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28769
|
-
type: 'string',
|
|
28770
|
-
},
|
|
28771
|
-
},
|
|
28772
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28773
|
-
type: 'object',
|
|
28774
|
-
},
|
|
28775
|
-
{
|
|
28776
|
-
description:
|
|
28777
|
-
'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
|
|
28778
|
-
properties: {
|
|
28779
|
-
created_at: {
|
|
28780
|
-
description:
|
|
28781
|
-
'Date and time at which Seam created the error.',
|
|
28782
|
-
format: 'date-time',
|
|
28783
|
-
type: 'string',
|
|
28784
|
-
},
|
|
28785
|
-
error_code: {
|
|
28786
|
-
description:
|
|
28787
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28788
|
-
enum: ['access_code_state_unconfirmed'],
|
|
28789
|
-
type: 'string',
|
|
28790
|
-
},
|
|
28791
|
-
is_access_code_error: {
|
|
28792
|
-
description:
|
|
28793
|
-
'Indicates that this is an access code error.',
|
|
28794
|
-
enum: [true],
|
|
28795
|
-
type: 'boolean',
|
|
28796
|
-
},
|
|
28797
|
-
message: {
|
|
28798
|
-
description:
|
|
28799
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28800
|
-
type: 'string',
|
|
28801
|
-
},
|
|
28802
|
-
},
|
|
28803
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28804
|
-
type: 'object',
|
|
28805
|
-
},
|
|
28806
|
-
{
|
|
28807
|
-
deprecated: true,
|
|
28808
|
-
description:
|
|
28809
|
-
'Unable to confirm that the access code is set on Kwikset device.',
|
|
28810
|
-
properties: {
|
|
28811
|
-
created_at: {
|
|
28812
|
-
description:
|
|
28813
|
-
'Date and time at which Seam created the error.',
|
|
28814
|
-
format: 'date-time',
|
|
28815
|
-
type: 'string',
|
|
28816
|
-
},
|
|
28817
|
-
error_code: {
|
|
28818
|
-
description:
|
|
28819
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28820
|
-
enum: ['kwikset_unable_to_confirm_code'],
|
|
28821
|
-
type: 'string',
|
|
28822
|
-
},
|
|
28823
|
-
is_access_code_error: {
|
|
28824
|
-
description:
|
|
28825
|
-
'Indicates that this is an access code error.',
|
|
28826
|
-
enum: [true],
|
|
28827
|
-
type: 'boolean',
|
|
28828
|
-
},
|
|
28829
|
-
message: {
|
|
28830
|
-
description:
|
|
28831
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28832
|
-
type: 'string',
|
|
28833
|
-
},
|
|
28834
|
-
},
|
|
28835
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28836
|
-
type: 'object',
|
|
28837
|
-
'x-deprecated':
|
|
28838
|
-
'Use `access_code_state_unconfirmed` instead.',
|
|
28839
|
-
},
|
|
28840
|
-
{
|
|
28841
|
-
deprecated: true,
|
|
28842
|
-
description:
|
|
28843
|
-
'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
28844
|
-
properties: {
|
|
28845
|
-
created_at: {
|
|
28846
|
-
description:
|
|
28847
|
-
'Date and time at which Seam created the error.',
|
|
28848
|
-
format: 'date-time',
|
|
28849
|
-
type: 'string',
|
|
28850
|
-
},
|
|
28851
|
-
error_code: {
|
|
28852
|
-
description:
|
|
28853
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28854
|
-
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
28855
|
-
type: 'string',
|
|
28856
|
-
},
|
|
28857
|
-
is_access_code_error: {
|
|
28858
|
-
description:
|
|
28859
|
-
'Indicates that this is an access code error.',
|
|
28860
|
-
enum: [true],
|
|
28861
|
-
type: 'boolean',
|
|
28862
|
-
},
|
|
28863
|
-
message: {
|
|
28864
|
-
description:
|
|
28865
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28866
|
-
type: 'string',
|
|
28867
|
-
},
|
|
28868
|
-
},
|
|
28869
|
-
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28870
|
-
type: 'object',
|
|
28871
|
-
'x-deprecated':
|
|
28872
|
-
'Use `access_code_state_unconfirmed` instead.',
|
|
28873
|
-
},
|
|
28006
|
+
type: 'string',
|
|
28007
|
+
},
|
|
28008
|
+
},
|
|
28009
|
+
required: ['stay_id', 'user_level_name'],
|
|
28010
|
+
type: 'object',
|
|
28011
|
+
},
|
|
28012
|
+
ends_at: {
|
|
28013
|
+
description:
|
|
28014
|
+
'Date and time after which the time-bound access code becomes inactive.',
|
|
28015
|
+
format: 'date-time',
|
|
28016
|
+
nullable: true,
|
|
28017
|
+
type: 'string',
|
|
28018
|
+
},
|
|
28019
|
+
errors: {
|
|
28020
|
+
description:
|
|
28021
|
+
'Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).',
|
|
28022
|
+
items: {
|
|
28023
|
+
discriminator: { propertyName: 'error_code' },
|
|
28024
|
+
oneOf: [
|
|
28874
28025
|
{
|
|
28875
28026
|
description:
|
|
28876
|
-
'
|
|
28027
|
+
'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
|
|
28877
28028
|
properties: {
|
|
28878
|
-
change_type: {
|
|
28879
|
-
description:
|
|
28880
|
-
"Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
28881
|
-
enum: ['modified', 'removed'],
|
|
28882
|
-
type: 'string',
|
|
28883
|
-
},
|
|
28884
28029
|
created_at: {
|
|
28885
28030
|
description:
|
|
28886
28031
|
'Date and time at which Seam created the error.',
|
|
@@ -28890,7 +28035,7 @@ const openapi: OpenAPISpec = {
|
|
|
28890
28035
|
error_code: {
|
|
28891
28036
|
description:
|
|
28892
28037
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28893
|
-
enum: ['
|
|
28038
|
+
enum: ['provider_issue'],
|
|
28894
28039
|
type: 'string',
|
|
28895
28040
|
},
|
|
28896
28041
|
is_access_code_error: {
|
|
@@ -28904,39 +28049,12 @@ const openapi: OpenAPISpec = {
|
|
|
28904
28049
|
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28905
28050
|
type: 'string',
|
|
28906
28051
|
},
|
|
28907
|
-
modified_fields: {
|
|
28908
|
-
description:
|
|
28909
|
-
'List of fields that were changed externally, with their previous and new values.',
|
|
28910
|
-
items: {
|
|
28911
|
-
properties: {
|
|
28912
|
-
field: {
|
|
28913
|
-
description:
|
|
28914
|
-
'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
28915
|
-
type: 'string',
|
|
28916
|
-
},
|
|
28917
|
-
from: {
|
|
28918
|
-
description: 'The previous value of the field.',
|
|
28919
|
-
nullable: true,
|
|
28920
|
-
type: 'string',
|
|
28921
|
-
},
|
|
28922
|
-
to: {
|
|
28923
|
-
description: 'The new value of the field.',
|
|
28924
|
-
nullable: true,
|
|
28925
|
-
type: 'string',
|
|
28926
|
-
},
|
|
28927
|
-
},
|
|
28928
|
-
required: ['field', 'from', 'to'],
|
|
28929
|
-
type: 'object',
|
|
28930
|
-
},
|
|
28931
|
-
type: 'array',
|
|
28932
|
-
},
|
|
28933
28052
|
},
|
|
28934
28053
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28935
28054
|
type: 'object',
|
|
28936
28055
|
},
|
|
28937
28056
|
{
|
|
28938
|
-
|
|
28939
|
-
description: 'Invalid code length for August lock.',
|
|
28057
|
+
description: 'Failed to set code on device.',
|
|
28940
28058
|
properties: {
|
|
28941
28059
|
created_at: {
|
|
28942
28060
|
description:
|
|
@@ -28947,7 +28065,7 @@ const openapi: OpenAPISpec = {
|
|
|
28947
28065
|
error_code: {
|
|
28948
28066
|
description:
|
|
28949
28067
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28950
|
-
enum: ['
|
|
28068
|
+
enum: ['failed_to_set_on_device'],
|
|
28951
28069
|
type: 'string',
|
|
28952
28070
|
},
|
|
28953
28071
|
is_access_code_error: {
|
|
@@ -28964,11 +28082,9 @@ const openapi: OpenAPISpec = {
|
|
|
28964
28082
|
},
|
|
28965
28083
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28966
28084
|
type: 'object',
|
|
28967
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
28968
28085
|
},
|
|
28969
28086
|
{
|
|
28970
|
-
|
|
28971
|
-
description: 'August lock is missing a keypad.',
|
|
28087
|
+
description: 'Failed to remove code from device.',
|
|
28972
28088
|
properties: {
|
|
28973
28089
|
created_at: {
|
|
28974
28090
|
description:
|
|
@@ -28979,7 +28095,7 @@ const openapi: OpenAPISpec = {
|
|
|
28979
28095
|
error_code: {
|
|
28980
28096
|
description:
|
|
28981
28097
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28982
|
-
enum: ['
|
|
28098
|
+
enum: ['failed_to_remove_from_device'],
|
|
28983
28099
|
type: 'string',
|
|
28984
28100
|
},
|
|
28985
28101
|
is_access_code_error: {
|
|
@@ -28996,11 +28112,9 @@ const openapi: OpenAPISpec = {
|
|
|
28996
28112
|
},
|
|
28997
28113
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28998
28114
|
type: 'object',
|
|
28999
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
29000
28115
|
},
|
|
29001
28116
|
{
|
|
29002
|
-
|
|
29003
|
-
description: 'August lock is temporarily offline.',
|
|
28117
|
+
description: 'Duplicate access code detected on device.',
|
|
29004
28118
|
properties: {
|
|
29005
28119
|
created_at: {
|
|
29006
28120
|
description:
|
|
@@ -29011,7 +28125,7 @@ const openapi: OpenAPISpec = {
|
|
|
29011
28125
|
error_code: {
|
|
29012
28126
|
description:
|
|
29013
28127
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29014
|
-
enum: ['
|
|
28128
|
+
enum: ['duplicate_code_on_device'],
|
|
29015
28129
|
type: 'string',
|
|
29016
28130
|
},
|
|
29017
28131
|
is_access_code_error: {
|
|
@@ -29020,19 +28134,30 @@ const openapi: OpenAPISpec = {
|
|
|
29020
28134
|
enum: [true],
|
|
29021
28135
|
type: 'boolean',
|
|
29022
28136
|
},
|
|
28137
|
+
managed_access_code_id: {
|
|
28138
|
+
description:
|
|
28139
|
+
'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.',
|
|
28140
|
+
format: 'uuid',
|
|
28141
|
+
type: 'string',
|
|
28142
|
+
},
|
|
29023
28143
|
message: {
|
|
29024
28144
|
description:
|
|
29025
28145
|
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
29026
28146
|
type: 'string',
|
|
29027
28147
|
},
|
|
28148
|
+
unmanaged_access_code_id: {
|
|
28149
|
+
description:
|
|
28150
|
+
'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.',
|
|
28151
|
+
format: 'uuid',
|
|
28152
|
+
type: 'string',
|
|
28153
|
+
},
|
|
29028
28154
|
},
|
|
29029
28155
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
29030
28156
|
type: 'object',
|
|
29031
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
29032
28157
|
},
|
|
29033
28158
|
{
|
|
29034
28159
|
description:
|
|
29035
|
-
'
|
|
28160
|
+
'An attempt to modify this access code was prevented.',
|
|
29036
28161
|
properties: {
|
|
29037
28162
|
created_at: {
|
|
29038
28163
|
description:
|
|
@@ -29043,7 +28168,7 @@ const openapi: OpenAPISpec = {
|
|
|
29043
28168
|
error_code: {
|
|
29044
28169
|
description:
|
|
29045
28170
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29046
|
-
enum: ['
|
|
28171
|
+
enum: ['duplicate_code_attempt_prevented'],
|
|
29047
28172
|
type: 'string',
|
|
29048
28173
|
},
|
|
29049
28174
|
is_access_code_error: {
|
|
@@ -29062,8 +28187,7 @@ const openapi: OpenAPISpec = {
|
|
|
29062
28187
|
type: 'object',
|
|
29063
28188
|
},
|
|
29064
28189
|
{
|
|
29065
|
-
|
|
29066
|
-
description: 'Salto site user is not subscribed.',
|
|
28190
|
+
description: 'No space for access code on device.',
|
|
29067
28191
|
properties: {
|
|
29068
28192
|
created_at: {
|
|
29069
28193
|
description:
|
|
@@ -29074,7 +28198,7 @@ const openapi: OpenAPISpec = {
|
|
|
29074
28198
|
error_code: {
|
|
29075
28199
|
description:
|
|
29076
28200
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29077
|
-
enum: ['
|
|
28201
|
+
enum: ['no_space_for_access_code_on_device'],
|
|
29078
28202
|
type: 'string',
|
|
29079
28203
|
},
|
|
29080
28204
|
is_access_code_error: {
|
|
@@ -29091,11 +28215,10 @@ const openapi: OpenAPISpec = {
|
|
|
29091
28215
|
},
|
|
29092
28216
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
29093
28217
|
type: 'object',
|
|
29094
|
-
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
29095
28218
|
},
|
|
29096
28219
|
{
|
|
29097
|
-
|
|
29098
|
-
|
|
28220
|
+
description:
|
|
28221
|
+
'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
|
|
29099
28222
|
properties: {
|
|
29100
28223
|
created_at: {
|
|
29101
28224
|
description:
|
|
@@ -29106,7 +28229,7 @@ const openapi: OpenAPISpec = {
|
|
|
29106
28229
|
error_code: {
|
|
29107
28230
|
description:
|
|
29108
28231
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29109
|
-
enum: ['
|
|
28232
|
+
enum: ['access_code_state_unconfirmed'],
|
|
29110
28233
|
type: 'string',
|
|
29111
28234
|
},
|
|
29112
28235
|
is_access_code_error: {
|
|
@@ -29123,12 +28246,17 @@ const openapi: OpenAPISpec = {
|
|
|
29123
28246
|
},
|
|
29124
28247
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
29125
28248
|
type: 'object',
|
|
29126
|
-
'x-deprecated': 'Use `duplicate_code_on_device` instead.',
|
|
29127
28249
|
},
|
|
29128
28250
|
{
|
|
29129
|
-
|
|
29130
|
-
|
|
28251
|
+
description:
|
|
28252
|
+
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
29131
28253
|
properties: {
|
|
28254
|
+
change_type: {
|
|
28255
|
+
description:
|
|
28256
|
+
"Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
28257
|
+
enum: ['modified', 'removed'],
|
|
28258
|
+
type: 'string',
|
|
28259
|
+
},
|
|
29132
28260
|
created_at: {
|
|
29133
28261
|
description:
|
|
29134
28262
|
'Date and time at which Seam created the error.',
|
|
@@ -29138,7 +28266,7 @@ const openapi: OpenAPISpec = {
|
|
|
29138
28266
|
error_code: {
|
|
29139
28267
|
description:
|
|
29140
28268
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29141
|
-
enum: ['
|
|
28269
|
+
enum: ['code_modified_external_to_seam'],
|
|
29142
28270
|
type: 'string',
|
|
29143
28271
|
},
|
|
29144
28272
|
is_access_code_error: {
|
|
@@ -29152,15 +28280,39 @@ const openapi: OpenAPISpec = {
|
|
|
29152
28280
|
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
29153
28281
|
type: 'string',
|
|
29154
28282
|
},
|
|
28283
|
+
modified_fields: {
|
|
28284
|
+
description:
|
|
28285
|
+
'List of fields that were changed externally, with their previous and new values.',
|
|
28286
|
+
items: {
|
|
28287
|
+
properties: {
|
|
28288
|
+
field: {
|
|
28289
|
+
description:
|
|
28290
|
+
'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
28291
|
+
type: 'string',
|
|
28292
|
+
},
|
|
28293
|
+
from: {
|
|
28294
|
+
description: 'The previous value of the field.',
|
|
28295
|
+
nullable: true,
|
|
28296
|
+
type: 'string',
|
|
28297
|
+
},
|
|
28298
|
+
to: {
|
|
28299
|
+
description: 'The new value of the field.',
|
|
28300
|
+
nullable: true,
|
|
28301
|
+
type: 'string',
|
|
28302
|
+
},
|
|
28303
|
+
},
|
|
28304
|
+
required: ['field', 'from', 'to'],
|
|
28305
|
+
type: 'object',
|
|
28306
|
+
},
|
|
28307
|
+
type: 'array',
|
|
28308
|
+
},
|
|
29155
28309
|
},
|
|
29156
28310
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
29157
28311
|
type: 'object',
|
|
29158
|
-
'x-deprecated': 'Use `duplicate_code_on_device` instead.',
|
|
29159
28312
|
},
|
|
29160
28313
|
{
|
|
29161
|
-
deprecated: true,
|
|
29162
28314
|
description:
|
|
29163
|
-
'
|
|
28315
|
+
'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
29164
28316
|
properties: {
|
|
29165
28317
|
created_at: {
|
|
29166
28318
|
description:
|
|
@@ -29171,7 +28323,7 @@ const openapi: OpenAPISpec = {
|
|
|
29171
28323
|
error_code: {
|
|
29172
28324
|
description:
|
|
29173
28325
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29174
|
-
enum: ['
|
|
28326
|
+
enum: ['access_code_inactive'],
|
|
29175
28327
|
type: 'string',
|
|
29176
28328
|
},
|
|
29177
28329
|
is_access_code_error: {
|
|
@@ -29188,11 +28340,10 @@ const openapi: OpenAPISpec = {
|
|
|
29188
28340
|
},
|
|
29189
28341
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
29190
28342
|
type: 'object',
|
|
29191
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
29192
28343
|
},
|
|
29193
28344
|
{
|
|
29194
|
-
|
|
29195
|
-
|
|
28345
|
+
deprecated: true,
|
|
28346
|
+
description: 'Salto site user is not subscribed.',
|
|
29196
28347
|
properties: {
|
|
29197
28348
|
created_at: {
|
|
29198
28349
|
description:
|
|
@@ -29203,7 +28354,7 @@ const openapi: OpenAPISpec = {
|
|
|
29203
28354
|
error_code: {
|
|
29204
28355
|
description:
|
|
29205
28356
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29206
|
-
enum: ['
|
|
28357
|
+
enum: ['salto_ks_user_not_subscribed'],
|
|
29207
28358
|
type: 'string',
|
|
29208
28359
|
},
|
|
29209
28360
|
is_access_code_error: {
|
|
@@ -29220,10 +28371,11 @@ const openapi: OpenAPISpec = {
|
|
|
29220
28371
|
},
|
|
29221
28372
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
29222
28373
|
type: 'object',
|
|
28374
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
29223
28375
|
},
|
|
29224
28376
|
{
|
|
29225
|
-
|
|
29226
|
-
|
|
28377
|
+
description:
|
|
28378
|
+
'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
|
|
29227
28379
|
properties: {
|
|
29228
28380
|
created_at: {
|
|
29229
28381
|
description:
|
|
@@ -29234,7 +28386,7 @@ const openapi: OpenAPISpec = {
|
|
|
29234
28386
|
error_code: {
|
|
29235
28387
|
description:
|
|
29236
28388
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29237
|
-
enum: ['
|
|
28389
|
+
enum: ['insufficient_permissions'],
|
|
29238
28390
|
type: 'string',
|
|
29239
28391
|
},
|
|
29240
28392
|
is_access_code_error: {
|
|
@@ -29251,7 +28403,6 @@ const openapi: OpenAPISpec = {
|
|
|
29251
28403
|
},
|
|
29252
28404
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
29253
28405
|
type: 'object',
|
|
29254
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
29255
28406
|
},
|
|
29256
28407
|
{
|
|
29257
28408
|
description:
|
|
@@ -29954,30 +29105,6 @@ const openapi: OpenAPISpec = {
|
|
|
29954
29105
|
required: ['message', 'warning_code'],
|
|
29955
29106
|
type: 'object',
|
|
29956
29107
|
},
|
|
29957
|
-
{
|
|
29958
|
-
description: 'Failed to set code on SmartThings device.',
|
|
29959
|
-
properties: {
|
|
29960
|
-
created_at: {
|
|
29961
|
-
description:
|
|
29962
|
-
'Date and time at which Seam created the warning.',
|
|
29963
|
-
format: 'date-time',
|
|
29964
|
-
type: 'string',
|
|
29965
|
-
},
|
|
29966
|
-
message: {
|
|
29967
|
-
description:
|
|
29968
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29969
|
-
type: 'string',
|
|
29970
|
-
},
|
|
29971
|
-
warning_code: {
|
|
29972
|
-
description:
|
|
29973
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29974
|
-
enum: ['smartthings_failed_to_set_access_code'],
|
|
29975
|
-
type: 'string',
|
|
29976
|
-
},
|
|
29977
|
-
},
|
|
29978
|
-
required: ['message', 'warning_code'],
|
|
29979
|
-
type: 'object',
|
|
29980
|
-
},
|
|
29981
29108
|
{
|
|
29982
29109
|
deprecated: true,
|
|
29983
29110
|
description: 'Duplicate access code detected.',
|
|
@@ -30005,33 +29132,6 @@ const openapi: OpenAPISpec = {
|
|
|
30005
29132
|
'x-deprecated':
|
|
30006
29133
|
'Use `duplicate_code_on_device` error instead.',
|
|
30007
29134
|
},
|
|
30008
|
-
{
|
|
30009
|
-
deprecated: true,
|
|
30010
|
-
description:
|
|
30011
|
-
'Received an error when attempting to create this code.',
|
|
30012
|
-
properties: {
|
|
30013
|
-
created_at: {
|
|
30014
|
-
description:
|
|
30015
|
-
'Date and time at which Seam created the warning.',
|
|
30016
|
-
format: 'date-time',
|
|
30017
|
-
type: 'string',
|
|
30018
|
-
},
|
|
30019
|
-
message: {
|
|
30020
|
-
description:
|
|
30021
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30022
|
-
type: 'string',
|
|
30023
|
-
},
|
|
30024
|
-
warning_code: {
|
|
30025
|
-
description:
|
|
30026
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30027
|
-
enum: ['schlage_creation_outage'],
|
|
30028
|
-
type: 'string',
|
|
30029
|
-
},
|
|
30030
|
-
},
|
|
30031
|
-
required: ['message', 'warning_code'],
|
|
30032
|
-
type: 'object',
|
|
30033
|
-
'x-deprecated': 'Use `provider_issue` instead.',
|
|
30034
|
-
},
|
|
30035
29135
|
{
|
|
30036
29136
|
description:
|
|
30037
29137
|
"The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|
|
@@ -30187,30 +29287,6 @@ const openapi: OpenAPISpec = {
|
|
|
30187
29287
|
required: ['message', 'warning_code'],
|
|
30188
29288
|
type: 'object',
|
|
30189
29289
|
},
|
|
30190
|
-
{
|
|
30191
|
-
description: 'August lock is temporarily offline.',
|
|
30192
|
-
properties: {
|
|
30193
|
-
created_at: {
|
|
30194
|
-
description:
|
|
30195
|
-
'Date and time at which Seam created the warning.',
|
|
30196
|
-
format: 'date-time',
|
|
30197
|
-
type: 'string',
|
|
30198
|
-
},
|
|
30199
|
-
message: {
|
|
30200
|
-
description:
|
|
30201
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30202
|
-
type: 'string',
|
|
30203
|
-
},
|
|
30204
|
-
warning_code: {
|
|
30205
|
-
description:
|
|
30206
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30207
|
-
enum: ['august_lock_temporarily_offline'],
|
|
30208
|
-
type: 'string',
|
|
30209
|
-
},
|
|
30210
|
-
},
|
|
30211
|
-
required: ['message', 'warning_code'],
|
|
30212
|
-
type: 'object',
|
|
30213
|
-
},
|
|
30214
29290
|
{
|
|
30215
29291
|
description: 'Algopins must be used within 24 hours.',
|
|
30216
29292
|
properties: {
|
|
@@ -30260,31 +29336,6 @@ const openapi: OpenAPISpec = {
|
|
|
30260
29336
|
required: ['message', 'warning_code'],
|
|
30261
29337
|
type: 'object',
|
|
30262
29338
|
},
|
|
30263
|
-
{
|
|
30264
|
-
description:
|
|
30265
|
-
'Unable to confirm that the access code is set on Kwikset device.',
|
|
30266
|
-
properties: {
|
|
30267
|
-
created_at: {
|
|
30268
|
-
description:
|
|
30269
|
-
'Date and time at which Seam created the warning.',
|
|
30270
|
-
format: 'date-time',
|
|
30271
|
-
type: 'string',
|
|
30272
|
-
},
|
|
30273
|
-
message: {
|
|
30274
|
-
description:
|
|
30275
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30276
|
-
type: 'string',
|
|
30277
|
-
},
|
|
30278
|
-
warning_code: {
|
|
30279
|
-
description:
|
|
30280
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30281
|
-
enum: ['kwikset_unable_to_confirm_code'],
|
|
30282
|
-
type: 'string',
|
|
30283
|
-
},
|
|
30284
|
-
},
|
|
30285
|
-
required: ['message', 'warning_code'],
|
|
30286
|
-
type: 'object',
|
|
30287
|
-
},
|
|
30288
29339
|
{
|
|
30289
29340
|
description:
|
|
30290
29341
|
'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
@@ -30310,33 +29361,6 @@ const openapi: OpenAPISpec = {
|
|
|
30310
29361
|
required: ['message', 'warning_code'],
|
|
30311
29362
|
type: 'object',
|
|
30312
29363
|
},
|
|
30313
|
-
{
|
|
30314
|
-
deprecated: true,
|
|
30315
|
-
description:
|
|
30316
|
-
'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
|
|
30317
|
-
properties: {
|
|
30318
|
-
created_at: {
|
|
30319
|
-
description:
|
|
30320
|
-
'Date and time at which Seam created the warning.',
|
|
30321
|
-
format: 'date-time',
|
|
30322
|
-
type: 'string',
|
|
30323
|
-
},
|
|
30324
|
-
message: {
|
|
30325
|
-
description:
|
|
30326
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30327
|
-
type: 'string',
|
|
30328
|
-
},
|
|
30329
|
-
warning_code: {
|
|
30330
|
-
description:
|
|
30331
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30332
|
-
enum: ['ultraloq_access_code_disabled'],
|
|
30333
|
-
type: 'string',
|
|
30334
|
-
},
|
|
30335
|
-
},
|
|
30336
|
-
required: ['message', 'warning_code'],
|
|
30337
|
-
type: 'object',
|
|
30338
|
-
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
30339
|
-
},
|
|
30340
29364
|
{
|
|
30341
29365
|
description:
|
|
30342
29366
|
'A backup access code has been pulled and is being used in place of this access code.',
|