@seamapi/types 1.870.0 → 1.872.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 +438 -30
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1314 -0
- package/dist/index.cjs +438 -30
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +414 -10
- package/lib/seam/connect/models/access-codes/managed-access-code.js +108 -10
- 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 +149 -0
- package/lib/seam/connect/models/batch.d.ts +402 -0
- package/lib/seam/connect/openapi.js +302 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +517 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +144 -10
- package/src/lib/seam/connect/openapi.ts +346 -0
- package/src/lib/seam/connect/route-types.ts +594 -0
|
@@ -105,6 +105,38 @@ const openapi: OpenAPISpec = {
|
|
|
105
105
|
discriminator: { propertyName: 'error_code' },
|
|
106
106
|
oneOf: [
|
|
107
107
|
{
|
|
108
|
+
description:
|
|
109
|
+
'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
|
|
110
|
+
properties: {
|
|
111
|
+
created_at: {
|
|
112
|
+
description:
|
|
113
|
+
'Date and time at which Seam created the error.',
|
|
114
|
+
format: 'date-time',
|
|
115
|
+
type: 'string',
|
|
116
|
+
},
|
|
117
|
+
error_code: {
|
|
118
|
+
description:
|
|
119
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
120
|
+
enum: ['provider_issue'],
|
|
121
|
+
type: 'string',
|
|
122
|
+
},
|
|
123
|
+
is_access_code_error: {
|
|
124
|
+
description:
|
|
125
|
+
'Indicates that this is an access code error.',
|
|
126
|
+
enum: [true],
|
|
127
|
+
type: 'boolean',
|
|
128
|
+
},
|
|
129
|
+
message: {
|
|
130
|
+
description:
|
|
131
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
132
|
+
type: 'string',
|
|
133
|
+
},
|
|
134
|
+
},
|
|
135
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
136
|
+
type: 'object',
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
deprecated: true,
|
|
108
140
|
description: 'Failed to set code on SmartThings device.',
|
|
109
141
|
properties: {
|
|
110
142
|
created_at: {
|
|
@@ -133,8 +165,11 @@ const openapi: OpenAPISpec = {
|
|
|
133
165
|
},
|
|
134
166
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
135
167
|
type: 'object',
|
|
168
|
+
'x-deprecated':
|
|
169
|
+
'Handled by the generic `failed_to_set_on_device` system.',
|
|
136
170
|
},
|
|
137
171
|
{
|
|
172
|
+
deprecated: true,
|
|
138
173
|
description: 'Failed to set code after multiple retries.',
|
|
139
174
|
properties: {
|
|
140
175
|
created_at: {
|
|
@@ -165,6 +200,8 @@ const openapi: OpenAPISpec = {
|
|
|
165
200
|
},
|
|
166
201
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
167
202
|
type: 'object',
|
|
203
|
+
'x-deprecated':
|
|
204
|
+
'Handled by the generic `failed_to_set_on_device` system.',
|
|
168
205
|
},
|
|
169
206
|
{
|
|
170
207
|
description: 'Failed to set code on device.',
|
|
@@ -432,6 +469,12 @@ const openapi: OpenAPISpec = {
|
|
|
432
469
|
description:
|
|
433
470
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
434
471
|
properties: {
|
|
472
|
+
change_type: {
|
|
473
|
+
description:
|
|
474
|
+
"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.",
|
|
475
|
+
enum: ['modified', 'removed'],
|
|
476
|
+
type: 'string',
|
|
477
|
+
},
|
|
435
478
|
created_at: {
|
|
436
479
|
description:
|
|
437
480
|
'Date and time at which Seam created the error.',
|
|
@@ -455,11 +498,38 @@ const openapi: OpenAPISpec = {
|
|
|
455
498
|
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
456
499
|
type: 'string',
|
|
457
500
|
},
|
|
501
|
+
modified_fields: {
|
|
502
|
+
description:
|
|
503
|
+
'List of fields that were changed externally, with their previous and new values.',
|
|
504
|
+
items: {
|
|
505
|
+
properties: {
|
|
506
|
+
field: {
|
|
507
|
+
description:
|
|
508
|
+
'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
509
|
+
type: 'string',
|
|
510
|
+
},
|
|
511
|
+
from: {
|
|
512
|
+
description: 'The previous value of the field.',
|
|
513
|
+
nullable: true,
|
|
514
|
+
type: 'string',
|
|
515
|
+
},
|
|
516
|
+
to: {
|
|
517
|
+
description: 'The new value of the field.',
|
|
518
|
+
nullable: true,
|
|
519
|
+
type: 'string',
|
|
520
|
+
},
|
|
521
|
+
},
|
|
522
|
+
required: ['field', 'from', 'to'],
|
|
523
|
+
type: 'object',
|
|
524
|
+
},
|
|
525
|
+
type: 'array',
|
|
526
|
+
},
|
|
458
527
|
},
|
|
459
528
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
460
529
|
type: 'object',
|
|
461
530
|
},
|
|
462
531
|
{
|
|
532
|
+
deprecated: true,
|
|
463
533
|
description: 'Invalid code length for August lock.',
|
|
464
534
|
properties: {
|
|
465
535
|
created_at: {
|
|
@@ -488,8 +558,10 @@ const openapi: OpenAPISpec = {
|
|
|
488
558
|
},
|
|
489
559
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
490
560
|
type: 'object',
|
|
561
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
491
562
|
},
|
|
492
563
|
{
|
|
564
|
+
deprecated: true,
|
|
493
565
|
description: 'August lock is missing a keypad.',
|
|
494
566
|
properties: {
|
|
495
567
|
created_at: {
|
|
@@ -518,8 +590,10 @@ const openapi: OpenAPISpec = {
|
|
|
518
590
|
},
|
|
519
591
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
520
592
|
type: 'object',
|
|
593
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
521
594
|
},
|
|
522
595
|
{
|
|
596
|
+
deprecated: true,
|
|
523
597
|
description: 'August lock is temporarily offline.',
|
|
524
598
|
properties: {
|
|
525
599
|
created_at: {
|
|
@@ -548,8 +622,41 @@ const openapi: OpenAPISpec = {
|
|
|
548
622
|
},
|
|
549
623
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
550
624
|
type: 'object',
|
|
625
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
description:
|
|
629
|
+
'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
630
|
+
properties: {
|
|
631
|
+
created_at: {
|
|
632
|
+
description:
|
|
633
|
+
'Date and time at which Seam created the error.',
|
|
634
|
+
format: 'date-time',
|
|
635
|
+
type: 'string',
|
|
636
|
+
},
|
|
637
|
+
error_code: {
|
|
638
|
+
description:
|
|
639
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
640
|
+
enum: ['access_code_inactive'],
|
|
641
|
+
type: 'string',
|
|
642
|
+
},
|
|
643
|
+
is_access_code_error: {
|
|
644
|
+
description:
|
|
645
|
+
'Indicates that this is an access code error.',
|
|
646
|
+
enum: [true],
|
|
647
|
+
type: 'boolean',
|
|
648
|
+
},
|
|
649
|
+
message: {
|
|
650
|
+
description:
|
|
651
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
652
|
+
type: 'string',
|
|
653
|
+
},
|
|
654
|
+
},
|
|
655
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
656
|
+
type: 'object',
|
|
551
657
|
},
|
|
552
658
|
{
|
|
659
|
+
deprecated: true,
|
|
553
660
|
description: 'Salto site user is not subscribed.',
|
|
554
661
|
properties: {
|
|
555
662
|
created_at: {
|
|
@@ -578,6 +685,7 @@ const openapi: OpenAPISpec = {
|
|
|
578
685
|
},
|
|
579
686
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
580
687
|
type: 'object',
|
|
688
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
581
689
|
},
|
|
582
690
|
{
|
|
583
691
|
deprecated: true,
|
|
@@ -644,6 +752,7 @@ const openapi: OpenAPISpec = {
|
|
|
644
752
|
'x-deprecated': 'Use `duplicate_code_on_device` instead.',
|
|
645
753
|
},
|
|
646
754
|
{
|
|
755
|
+
deprecated: true,
|
|
647
756
|
description:
|
|
648
757
|
'No Dormakaba Oracode user levels configured for the requested time range.',
|
|
649
758
|
properties: {
|
|
@@ -673,8 +782,10 @@ const openapi: OpenAPISpec = {
|
|
|
673
782
|
},
|
|
674
783
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
675
784
|
type: 'object',
|
|
785
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
676
786
|
},
|
|
677
787
|
{
|
|
788
|
+
deprecated: true,
|
|
678
789
|
description:
|
|
679
790
|
'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
|
|
680
791
|
properties: {
|
|
@@ -704,8 +815,10 @@ const openapi: OpenAPISpec = {
|
|
|
704
815
|
},
|
|
705
816
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
706
817
|
type: 'object',
|
|
818
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
707
819
|
},
|
|
708
820
|
{
|
|
821
|
+
deprecated: true,
|
|
709
822
|
description: 'KeyNest locker is not supported.',
|
|
710
823
|
properties: {
|
|
711
824
|
created_at: {
|
|
@@ -734,6 +847,7 @@ const openapi: OpenAPISpec = {
|
|
|
734
847
|
},
|
|
735
848
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
736
849
|
type: 'object',
|
|
850
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
737
851
|
},
|
|
738
852
|
{
|
|
739
853
|
description:
|
|
@@ -1687,6 +1801,31 @@ const openapi: OpenAPISpec = {
|
|
|
1687
1801
|
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
1688
1802
|
discriminator: { propertyName: 'warning_code' },
|
|
1689
1803
|
oneOf: [
|
|
1804
|
+
{
|
|
1805
|
+
description:
|
|
1806
|
+
'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
|
|
1807
|
+
properties: {
|
|
1808
|
+
created_at: {
|
|
1809
|
+
description:
|
|
1810
|
+
'Date and time at which Seam created the warning.',
|
|
1811
|
+
format: 'date-time',
|
|
1812
|
+
type: 'string',
|
|
1813
|
+
},
|
|
1814
|
+
message: {
|
|
1815
|
+
description:
|
|
1816
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1817
|
+
type: 'string',
|
|
1818
|
+
},
|
|
1819
|
+
warning_code: {
|
|
1820
|
+
description:
|
|
1821
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1822
|
+
enum: ['provider_issue'],
|
|
1823
|
+
type: 'string',
|
|
1824
|
+
},
|
|
1825
|
+
},
|
|
1826
|
+
required: ['message', 'warning_code'],
|
|
1827
|
+
type: 'object',
|
|
1828
|
+
},
|
|
1690
1829
|
{
|
|
1691
1830
|
description: 'Failed to set code on SmartThings device.',
|
|
1692
1831
|
properties: {
|
|
@@ -1739,6 +1878,7 @@ const openapi: OpenAPISpec = {
|
|
|
1739
1878
|
'Use `duplicate_code_on_device` error instead.',
|
|
1740
1879
|
},
|
|
1741
1880
|
{
|
|
1881
|
+
deprecated: true,
|
|
1742
1882
|
description:
|
|
1743
1883
|
'Received an error when attempting to create this code.',
|
|
1744
1884
|
properties: {
|
|
@@ -1762,6 +1902,7 @@ const openapi: OpenAPISpec = {
|
|
|
1762
1902
|
},
|
|
1763
1903
|
required: ['message', 'warning_code'],
|
|
1764
1904
|
type: 'object',
|
|
1905
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
1765
1906
|
},
|
|
1766
1907
|
{
|
|
1767
1908
|
description:
|
|
@@ -1792,6 +1933,12 @@ const openapi: OpenAPISpec = {
|
|
|
1792
1933
|
description:
|
|
1793
1934
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
1794
1935
|
properties: {
|
|
1936
|
+
change_type: {
|
|
1937
|
+
description:
|
|
1938
|
+
"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.",
|
|
1939
|
+
enum: ['modified', 'removed'],
|
|
1940
|
+
type: 'string',
|
|
1941
|
+
},
|
|
1795
1942
|
created_at: {
|
|
1796
1943
|
description:
|
|
1797
1944
|
'Date and time at which Seam created the warning.',
|
|
@@ -1803,6 +1950,32 @@ const openapi: OpenAPISpec = {
|
|
|
1803
1950
|
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1804
1951
|
type: 'string',
|
|
1805
1952
|
},
|
|
1953
|
+
modified_fields: {
|
|
1954
|
+
description:
|
|
1955
|
+
'List of fields that were changed externally, with their previous and new values.',
|
|
1956
|
+
items: {
|
|
1957
|
+
properties: {
|
|
1958
|
+
field: {
|
|
1959
|
+
description:
|
|
1960
|
+
'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
1961
|
+
type: 'string',
|
|
1962
|
+
},
|
|
1963
|
+
from: {
|
|
1964
|
+
description: 'The previous value of the field.',
|
|
1965
|
+
nullable: true,
|
|
1966
|
+
type: 'string',
|
|
1967
|
+
},
|
|
1968
|
+
to: {
|
|
1969
|
+
description: 'The new value of the field.',
|
|
1970
|
+
nullable: true,
|
|
1971
|
+
type: 'string',
|
|
1972
|
+
},
|
|
1973
|
+
},
|
|
1974
|
+
required: ['field', 'from', 'to'],
|
|
1975
|
+
type: 'object',
|
|
1976
|
+
},
|
|
1977
|
+
type: 'array',
|
|
1978
|
+
},
|
|
1806
1979
|
warning_code: {
|
|
1807
1980
|
description:
|
|
1808
1981
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -27414,6 +27587,38 @@ const openapi: OpenAPISpec = {
|
|
|
27414
27587
|
discriminator: { propertyName: 'error_code' },
|
|
27415
27588
|
oneOf: [
|
|
27416
27589
|
{
|
|
27590
|
+
description:
|
|
27591
|
+
'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
|
|
27592
|
+
properties: {
|
|
27593
|
+
created_at: {
|
|
27594
|
+
description:
|
|
27595
|
+
'Date and time at which Seam created the error.',
|
|
27596
|
+
format: 'date-time',
|
|
27597
|
+
type: 'string',
|
|
27598
|
+
},
|
|
27599
|
+
error_code: {
|
|
27600
|
+
description:
|
|
27601
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27602
|
+
enum: ['provider_issue'],
|
|
27603
|
+
type: 'string',
|
|
27604
|
+
},
|
|
27605
|
+
is_access_code_error: {
|
|
27606
|
+
description:
|
|
27607
|
+
'Indicates that this is an access code error.',
|
|
27608
|
+
enum: [true],
|
|
27609
|
+
type: 'boolean',
|
|
27610
|
+
},
|
|
27611
|
+
message: {
|
|
27612
|
+
description:
|
|
27613
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27614
|
+
type: 'string',
|
|
27615
|
+
},
|
|
27616
|
+
},
|
|
27617
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27618
|
+
type: 'object',
|
|
27619
|
+
},
|
|
27620
|
+
{
|
|
27621
|
+
deprecated: true,
|
|
27417
27622
|
description: 'Failed to set code on SmartThings device.',
|
|
27418
27623
|
properties: {
|
|
27419
27624
|
created_at: {
|
|
@@ -27442,8 +27647,11 @@ const openapi: OpenAPISpec = {
|
|
|
27442
27647
|
},
|
|
27443
27648
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27444
27649
|
type: 'object',
|
|
27650
|
+
'x-deprecated':
|
|
27651
|
+
'Handled by the generic `failed_to_set_on_device` system.',
|
|
27445
27652
|
},
|
|
27446
27653
|
{
|
|
27654
|
+
deprecated: true,
|
|
27447
27655
|
description: 'Failed to set code after multiple retries.',
|
|
27448
27656
|
properties: {
|
|
27449
27657
|
created_at: {
|
|
@@ -27474,6 +27682,8 @@ const openapi: OpenAPISpec = {
|
|
|
27474
27682
|
},
|
|
27475
27683
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27476
27684
|
type: 'object',
|
|
27685
|
+
'x-deprecated':
|
|
27686
|
+
'Handled by the generic `failed_to_set_on_device` system.',
|
|
27477
27687
|
},
|
|
27478
27688
|
{
|
|
27479
27689
|
description: 'Failed to set code on device.',
|
|
@@ -27741,6 +27951,12 @@ const openapi: OpenAPISpec = {
|
|
|
27741
27951
|
description:
|
|
27742
27952
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
27743
27953
|
properties: {
|
|
27954
|
+
change_type: {
|
|
27955
|
+
description:
|
|
27956
|
+
"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.",
|
|
27957
|
+
enum: ['modified', 'removed'],
|
|
27958
|
+
type: 'string',
|
|
27959
|
+
},
|
|
27744
27960
|
created_at: {
|
|
27745
27961
|
description:
|
|
27746
27962
|
'Date and time at which Seam created the error.',
|
|
@@ -27764,11 +27980,38 @@ const openapi: OpenAPISpec = {
|
|
|
27764
27980
|
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27765
27981
|
type: 'string',
|
|
27766
27982
|
},
|
|
27983
|
+
modified_fields: {
|
|
27984
|
+
description:
|
|
27985
|
+
'List of fields that were changed externally, with their previous and new values.',
|
|
27986
|
+
items: {
|
|
27987
|
+
properties: {
|
|
27988
|
+
field: {
|
|
27989
|
+
description:
|
|
27990
|
+
'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
27991
|
+
type: 'string',
|
|
27992
|
+
},
|
|
27993
|
+
from: {
|
|
27994
|
+
description: 'The previous value of the field.',
|
|
27995
|
+
nullable: true,
|
|
27996
|
+
type: 'string',
|
|
27997
|
+
},
|
|
27998
|
+
to: {
|
|
27999
|
+
description: 'The new value of the field.',
|
|
28000
|
+
nullable: true,
|
|
28001
|
+
type: 'string',
|
|
28002
|
+
},
|
|
28003
|
+
},
|
|
28004
|
+
required: ['field', 'from', 'to'],
|
|
28005
|
+
type: 'object',
|
|
28006
|
+
},
|
|
28007
|
+
type: 'array',
|
|
28008
|
+
},
|
|
27767
28009
|
},
|
|
27768
28010
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27769
28011
|
type: 'object',
|
|
27770
28012
|
},
|
|
27771
28013
|
{
|
|
28014
|
+
deprecated: true,
|
|
27772
28015
|
description: 'Invalid code length for August lock.',
|
|
27773
28016
|
properties: {
|
|
27774
28017
|
created_at: {
|
|
@@ -27797,8 +28040,10 @@ const openapi: OpenAPISpec = {
|
|
|
27797
28040
|
},
|
|
27798
28041
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27799
28042
|
type: 'object',
|
|
28043
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
27800
28044
|
},
|
|
27801
28045
|
{
|
|
28046
|
+
deprecated: true,
|
|
27802
28047
|
description: 'August lock is missing a keypad.',
|
|
27803
28048
|
properties: {
|
|
27804
28049
|
created_at: {
|
|
@@ -27827,8 +28072,10 @@ const openapi: OpenAPISpec = {
|
|
|
27827
28072
|
},
|
|
27828
28073
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27829
28074
|
type: 'object',
|
|
28075
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
27830
28076
|
},
|
|
27831
28077
|
{
|
|
28078
|
+
deprecated: true,
|
|
27832
28079
|
description: 'August lock is temporarily offline.',
|
|
27833
28080
|
properties: {
|
|
27834
28081
|
created_at: {
|
|
@@ -27857,8 +28104,41 @@ const openapi: OpenAPISpec = {
|
|
|
27857
28104
|
},
|
|
27858
28105
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27859
28106
|
type: 'object',
|
|
28107
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
28108
|
+
},
|
|
28109
|
+
{
|
|
28110
|
+
description:
|
|
28111
|
+
'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
28112
|
+
properties: {
|
|
28113
|
+
created_at: {
|
|
28114
|
+
description:
|
|
28115
|
+
'Date and time at which Seam created the error.',
|
|
28116
|
+
format: 'date-time',
|
|
28117
|
+
type: 'string',
|
|
28118
|
+
},
|
|
28119
|
+
error_code: {
|
|
28120
|
+
description:
|
|
28121
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28122
|
+
enum: ['access_code_inactive'],
|
|
28123
|
+
type: 'string',
|
|
28124
|
+
},
|
|
28125
|
+
is_access_code_error: {
|
|
28126
|
+
description:
|
|
28127
|
+
'Indicates that this is an access code error.',
|
|
28128
|
+
enum: [true],
|
|
28129
|
+
type: 'boolean',
|
|
28130
|
+
},
|
|
28131
|
+
message: {
|
|
28132
|
+
description:
|
|
28133
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28134
|
+
type: 'string',
|
|
28135
|
+
},
|
|
28136
|
+
},
|
|
28137
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28138
|
+
type: 'object',
|
|
27860
28139
|
},
|
|
27861
28140
|
{
|
|
28141
|
+
deprecated: true,
|
|
27862
28142
|
description: 'Salto site user is not subscribed.',
|
|
27863
28143
|
properties: {
|
|
27864
28144
|
created_at: {
|
|
@@ -27887,6 +28167,7 @@ const openapi: OpenAPISpec = {
|
|
|
27887
28167
|
},
|
|
27888
28168
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27889
28169
|
type: 'object',
|
|
28170
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
27890
28171
|
},
|
|
27891
28172
|
{
|
|
27892
28173
|
deprecated: true,
|
|
@@ -27953,6 +28234,7 @@ const openapi: OpenAPISpec = {
|
|
|
27953
28234
|
'x-deprecated': 'Use `duplicate_code_on_device` instead.',
|
|
27954
28235
|
},
|
|
27955
28236
|
{
|
|
28237
|
+
deprecated: true,
|
|
27956
28238
|
description:
|
|
27957
28239
|
'No Dormakaba Oracode user levels configured for the requested time range.',
|
|
27958
28240
|
properties: {
|
|
@@ -27982,8 +28264,10 @@ const openapi: OpenAPISpec = {
|
|
|
27982
28264
|
},
|
|
27983
28265
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
27984
28266
|
type: 'object',
|
|
28267
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
27985
28268
|
},
|
|
27986
28269
|
{
|
|
28270
|
+
deprecated: true,
|
|
27987
28271
|
description:
|
|
27988
28272
|
'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
|
|
27989
28273
|
properties: {
|
|
@@ -28013,8 +28297,10 @@ const openapi: OpenAPISpec = {
|
|
|
28013
28297
|
},
|
|
28014
28298
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28015
28299
|
type: 'object',
|
|
28300
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
28016
28301
|
},
|
|
28017
28302
|
{
|
|
28303
|
+
deprecated: true,
|
|
28018
28304
|
description: 'KeyNest locker is not supported.',
|
|
28019
28305
|
properties: {
|
|
28020
28306
|
created_at: {
|
|
@@ -28043,6 +28329,7 @@ const openapi: OpenAPISpec = {
|
|
|
28043
28329
|
},
|
|
28044
28330
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28045
28331
|
type: 'object',
|
|
28332
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
28046
28333
|
},
|
|
28047
28334
|
{
|
|
28048
28335
|
description:
|
|
@@ -28685,6 +28972,31 @@ const openapi: OpenAPISpec = {
|
|
|
28685
28972
|
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
28686
28973
|
discriminator: { propertyName: 'warning_code' },
|
|
28687
28974
|
oneOf: [
|
|
28975
|
+
{
|
|
28976
|
+
description:
|
|
28977
|
+
'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
|
|
28978
|
+
properties: {
|
|
28979
|
+
created_at: {
|
|
28980
|
+
description:
|
|
28981
|
+
'Date and time at which Seam created the warning.',
|
|
28982
|
+
format: 'date-time',
|
|
28983
|
+
type: 'string',
|
|
28984
|
+
},
|
|
28985
|
+
message: {
|
|
28986
|
+
description:
|
|
28987
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28988
|
+
type: 'string',
|
|
28989
|
+
},
|
|
28990
|
+
warning_code: {
|
|
28991
|
+
description:
|
|
28992
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28993
|
+
enum: ['provider_issue'],
|
|
28994
|
+
type: 'string',
|
|
28995
|
+
},
|
|
28996
|
+
},
|
|
28997
|
+
required: ['message', 'warning_code'],
|
|
28998
|
+
type: 'object',
|
|
28999
|
+
},
|
|
28688
29000
|
{
|
|
28689
29001
|
description: 'Failed to set code on SmartThings device.',
|
|
28690
29002
|
properties: {
|
|
@@ -28737,6 +29049,7 @@ const openapi: OpenAPISpec = {
|
|
|
28737
29049
|
'Use `duplicate_code_on_device` error instead.',
|
|
28738
29050
|
},
|
|
28739
29051
|
{
|
|
29052
|
+
deprecated: true,
|
|
28740
29053
|
description:
|
|
28741
29054
|
'Received an error when attempting to create this code.',
|
|
28742
29055
|
properties: {
|
|
@@ -28760,6 +29073,7 @@ const openapi: OpenAPISpec = {
|
|
|
28760
29073
|
},
|
|
28761
29074
|
required: ['message', 'warning_code'],
|
|
28762
29075
|
type: 'object',
|
|
29076
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
28763
29077
|
},
|
|
28764
29078
|
{
|
|
28765
29079
|
description:
|
|
@@ -28790,6 +29104,12 @@ const openapi: OpenAPISpec = {
|
|
|
28790
29104
|
description:
|
|
28791
29105
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
28792
29106
|
properties: {
|
|
29107
|
+
change_type: {
|
|
29108
|
+
description:
|
|
29109
|
+
"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.",
|
|
29110
|
+
enum: ['modified', 'removed'],
|
|
29111
|
+
type: 'string',
|
|
29112
|
+
},
|
|
28793
29113
|
created_at: {
|
|
28794
29114
|
description:
|
|
28795
29115
|
'Date and time at which Seam created the warning.',
|
|
@@ -28801,6 +29121,32 @@ const openapi: OpenAPISpec = {
|
|
|
28801
29121
|
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28802
29122
|
type: 'string',
|
|
28803
29123
|
},
|
|
29124
|
+
modified_fields: {
|
|
29125
|
+
description:
|
|
29126
|
+
'List of fields that were changed externally, with their previous and new values.',
|
|
29127
|
+
items: {
|
|
29128
|
+
properties: {
|
|
29129
|
+
field: {
|
|
29130
|
+
description:
|
|
29131
|
+
'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
29132
|
+
type: 'string',
|
|
29133
|
+
},
|
|
29134
|
+
from: {
|
|
29135
|
+
description: 'The previous value of the field.',
|
|
29136
|
+
nullable: true,
|
|
29137
|
+
type: 'string',
|
|
29138
|
+
},
|
|
29139
|
+
to: {
|
|
29140
|
+
description: 'The new value of the field.',
|
|
29141
|
+
nullable: true,
|
|
29142
|
+
type: 'string',
|
|
29143
|
+
},
|
|
29144
|
+
},
|
|
29145
|
+
required: ['field', 'from', 'to'],
|
|
29146
|
+
type: 'object',
|
|
29147
|
+
},
|
|
29148
|
+
type: 'array',
|
|
29149
|
+
},
|
|
28804
29150
|
warning_code: {
|
|
28805
29151
|
description:
|
|
28806
29152
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|