@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
|
@@ -83,6 +83,33 @@ const openapi = {
|
|
|
83
83
|
discriminator: { propertyName: 'error_code' },
|
|
84
84
|
oneOf: [
|
|
85
85
|
{
|
|
86
|
+
description: 'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
|
|
87
|
+
properties: {
|
|
88
|
+
created_at: {
|
|
89
|
+
description: 'Date and time at which Seam created the error.',
|
|
90
|
+
format: 'date-time',
|
|
91
|
+
type: 'string',
|
|
92
|
+
},
|
|
93
|
+
error_code: {
|
|
94
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
95
|
+
enum: ['provider_issue'],
|
|
96
|
+
type: 'string',
|
|
97
|
+
},
|
|
98
|
+
is_access_code_error: {
|
|
99
|
+
description: 'Indicates that this is an access code error.',
|
|
100
|
+
enum: [true],
|
|
101
|
+
type: 'boolean',
|
|
102
|
+
},
|
|
103
|
+
message: {
|
|
104
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
105
|
+
type: 'string',
|
|
106
|
+
},
|
|
107
|
+
},
|
|
108
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
109
|
+
type: 'object',
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
deprecated: true,
|
|
86
113
|
description: 'Failed to set code on SmartThings device.',
|
|
87
114
|
properties: {
|
|
88
115
|
created_at: {
|
|
@@ -107,8 +134,10 @@ const openapi = {
|
|
|
107
134
|
},
|
|
108
135
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
109
136
|
type: 'object',
|
|
137
|
+
'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
|
|
110
138
|
},
|
|
111
139
|
{
|
|
140
|
+
deprecated: true,
|
|
112
141
|
description: 'Failed to set code after multiple retries.',
|
|
113
142
|
properties: {
|
|
114
143
|
created_at: {
|
|
@@ -135,6 +164,7 @@ const openapi = {
|
|
|
135
164
|
},
|
|
136
165
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
137
166
|
type: 'object',
|
|
167
|
+
'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
|
|
138
168
|
},
|
|
139
169
|
{
|
|
140
170
|
description: 'Failed to set code on device.',
|
|
@@ -361,6 +391,11 @@ const openapi = {
|
|
|
361
391
|
{
|
|
362
392
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
363
393
|
properties: {
|
|
394
|
+
change_type: {
|
|
395
|
+
description: "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.",
|
|
396
|
+
enum: ['modified', 'removed'],
|
|
397
|
+
type: 'string',
|
|
398
|
+
},
|
|
364
399
|
created_at: {
|
|
365
400
|
description: 'Date and time at which Seam created the error.',
|
|
366
401
|
format: 'date-time',
|
|
@@ -380,11 +415,36 @@ const openapi = {
|
|
|
380
415
|
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
381
416
|
type: 'string',
|
|
382
417
|
},
|
|
418
|
+
modified_fields: {
|
|
419
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
420
|
+
items: {
|
|
421
|
+
properties: {
|
|
422
|
+
field: {
|
|
423
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
424
|
+
type: 'string',
|
|
425
|
+
},
|
|
426
|
+
from: {
|
|
427
|
+
description: 'The previous value of the field.',
|
|
428
|
+
nullable: true,
|
|
429
|
+
type: 'string',
|
|
430
|
+
},
|
|
431
|
+
to: {
|
|
432
|
+
description: 'The new value of the field.',
|
|
433
|
+
nullable: true,
|
|
434
|
+
type: 'string',
|
|
435
|
+
},
|
|
436
|
+
},
|
|
437
|
+
required: ['field', 'from', 'to'],
|
|
438
|
+
type: 'object',
|
|
439
|
+
},
|
|
440
|
+
type: 'array',
|
|
441
|
+
},
|
|
383
442
|
},
|
|
384
443
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
385
444
|
type: 'object',
|
|
386
445
|
},
|
|
387
446
|
{
|
|
447
|
+
deprecated: true,
|
|
388
448
|
description: 'Invalid code length for August lock.',
|
|
389
449
|
properties: {
|
|
390
450
|
created_at: {
|
|
@@ -409,8 +469,10 @@ const openapi = {
|
|
|
409
469
|
},
|
|
410
470
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
411
471
|
type: 'object',
|
|
472
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
412
473
|
},
|
|
413
474
|
{
|
|
475
|
+
deprecated: true,
|
|
414
476
|
description: 'August lock is missing a keypad.',
|
|
415
477
|
properties: {
|
|
416
478
|
created_at: {
|
|
@@ -435,8 +497,10 @@ const openapi = {
|
|
|
435
497
|
},
|
|
436
498
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
437
499
|
type: 'object',
|
|
500
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
438
501
|
},
|
|
439
502
|
{
|
|
503
|
+
deprecated: true,
|
|
440
504
|
description: 'August lock is temporarily offline.',
|
|
441
505
|
properties: {
|
|
442
506
|
created_at: {
|
|
@@ -461,8 +525,36 @@ const openapi = {
|
|
|
461
525
|
},
|
|
462
526
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
463
527
|
type: 'object',
|
|
528
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
description: 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
532
|
+
properties: {
|
|
533
|
+
created_at: {
|
|
534
|
+
description: 'Date and time at which Seam created the error.',
|
|
535
|
+
format: 'date-time',
|
|
536
|
+
type: 'string',
|
|
537
|
+
},
|
|
538
|
+
error_code: {
|
|
539
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
540
|
+
enum: ['access_code_inactive'],
|
|
541
|
+
type: 'string',
|
|
542
|
+
},
|
|
543
|
+
is_access_code_error: {
|
|
544
|
+
description: 'Indicates that this is an access code error.',
|
|
545
|
+
enum: [true],
|
|
546
|
+
type: 'boolean',
|
|
547
|
+
},
|
|
548
|
+
message: {
|
|
549
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
550
|
+
type: 'string',
|
|
551
|
+
},
|
|
552
|
+
},
|
|
553
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
554
|
+
type: 'object',
|
|
464
555
|
},
|
|
465
556
|
{
|
|
557
|
+
deprecated: true,
|
|
466
558
|
description: 'Salto site user is not subscribed.',
|
|
467
559
|
properties: {
|
|
468
560
|
created_at: {
|
|
@@ -487,6 +579,7 @@ const openapi = {
|
|
|
487
579
|
},
|
|
488
580
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
489
581
|
type: 'object',
|
|
582
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
490
583
|
},
|
|
491
584
|
{
|
|
492
585
|
deprecated: true,
|
|
@@ -545,6 +638,7 @@ const openapi = {
|
|
|
545
638
|
'x-deprecated': 'Use `duplicate_code_on_device` instead.',
|
|
546
639
|
},
|
|
547
640
|
{
|
|
641
|
+
deprecated: true,
|
|
548
642
|
description: 'No Dormakaba Oracode user levels configured for the requested time range.',
|
|
549
643
|
properties: {
|
|
550
644
|
created_at: {
|
|
@@ -569,8 +663,10 @@ const openapi = {
|
|
|
569
663
|
},
|
|
570
664
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
571
665
|
type: 'object',
|
|
666
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
572
667
|
},
|
|
573
668
|
{
|
|
669
|
+
deprecated: true,
|
|
574
670
|
description: '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.',
|
|
575
671
|
properties: {
|
|
576
672
|
created_at: {
|
|
@@ -595,8 +691,10 @@ const openapi = {
|
|
|
595
691
|
},
|
|
596
692
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
597
693
|
type: 'object',
|
|
694
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
598
695
|
},
|
|
599
696
|
{
|
|
697
|
+
deprecated: true,
|
|
600
698
|
description: 'KeyNest locker is not supported.',
|
|
601
699
|
properties: {
|
|
602
700
|
created_at: {
|
|
@@ -621,6 +719,7 @@ const openapi = {
|
|
|
621
719
|
},
|
|
622
720
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
623
721
|
type: 'object',
|
|
722
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
624
723
|
},
|
|
625
724
|
{
|
|
626
725
|
description: 'This access code was overridden on the device by a newer access code programmed to the same slot.',
|
|
@@ -1464,6 +1563,27 @@ const openapi = {
|
|
|
1464
1563
|
description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
1465
1564
|
discriminator: { propertyName: 'warning_code' },
|
|
1466
1565
|
oneOf: [
|
|
1566
|
+
{
|
|
1567
|
+
description: 'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
|
|
1568
|
+
properties: {
|
|
1569
|
+
created_at: {
|
|
1570
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1571
|
+
format: 'date-time',
|
|
1572
|
+
type: 'string',
|
|
1573
|
+
},
|
|
1574
|
+
message: {
|
|
1575
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1576
|
+
type: 'string',
|
|
1577
|
+
},
|
|
1578
|
+
warning_code: {
|
|
1579
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1580
|
+
enum: ['provider_issue'],
|
|
1581
|
+
type: 'string',
|
|
1582
|
+
},
|
|
1583
|
+
},
|
|
1584
|
+
required: ['message', 'warning_code'],
|
|
1585
|
+
type: 'object',
|
|
1586
|
+
},
|
|
1467
1587
|
{
|
|
1468
1588
|
description: 'Failed to set code on SmartThings device.',
|
|
1469
1589
|
properties: {
|
|
@@ -1509,6 +1629,7 @@ const openapi = {
|
|
|
1509
1629
|
'x-deprecated': 'Use `duplicate_code_on_device` error instead.',
|
|
1510
1630
|
},
|
|
1511
1631
|
{
|
|
1632
|
+
deprecated: true,
|
|
1512
1633
|
description: 'Received an error when attempting to create this code.',
|
|
1513
1634
|
properties: {
|
|
1514
1635
|
created_at: {
|
|
@@ -1528,6 +1649,7 @@ const openapi = {
|
|
|
1528
1649
|
},
|
|
1529
1650
|
required: ['message', 'warning_code'],
|
|
1530
1651
|
type: 'object',
|
|
1652
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
1531
1653
|
},
|
|
1532
1654
|
{
|
|
1533
1655
|
description: "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.",
|
|
@@ -1553,6 +1675,11 @@ const openapi = {
|
|
|
1553
1675
|
{
|
|
1554
1676
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
1555
1677
|
properties: {
|
|
1678
|
+
change_type: {
|
|
1679
|
+
description: "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.",
|
|
1680
|
+
enum: ['modified', 'removed'],
|
|
1681
|
+
type: 'string',
|
|
1682
|
+
},
|
|
1556
1683
|
created_at: {
|
|
1557
1684
|
description: 'Date and time at which Seam created the warning.',
|
|
1558
1685
|
format: 'date-time',
|
|
@@ -1562,6 +1689,30 @@ const openapi = {
|
|
|
1562
1689
|
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1563
1690
|
type: 'string',
|
|
1564
1691
|
},
|
|
1692
|
+
modified_fields: {
|
|
1693
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
1694
|
+
items: {
|
|
1695
|
+
properties: {
|
|
1696
|
+
field: {
|
|
1697
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
1698
|
+
type: 'string',
|
|
1699
|
+
},
|
|
1700
|
+
from: {
|
|
1701
|
+
description: 'The previous value of the field.',
|
|
1702
|
+
nullable: true,
|
|
1703
|
+
type: 'string',
|
|
1704
|
+
},
|
|
1705
|
+
to: {
|
|
1706
|
+
description: 'The new value of the field.',
|
|
1707
|
+
nullable: true,
|
|
1708
|
+
type: 'string',
|
|
1709
|
+
},
|
|
1710
|
+
},
|
|
1711
|
+
required: ['field', 'from', 'to'],
|
|
1712
|
+
type: 'object',
|
|
1713
|
+
},
|
|
1714
|
+
type: 'array',
|
|
1715
|
+
},
|
|
1565
1716
|
warning_code: {
|
|
1566
1717
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1567
1718
|
enum: ['code_modified_external_to_seam'],
|
|
@@ -24585,6 +24736,33 @@ const openapi = {
|
|
|
24585
24736
|
discriminator: { propertyName: 'error_code' },
|
|
24586
24737
|
oneOf: [
|
|
24587
24738
|
{
|
|
24739
|
+
description: 'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
|
|
24740
|
+
properties: {
|
|
24741
|
+
created_at: {
|
|
24742
|
+
description: 'Date and time at which Seam created the error.',
|
|
24743
|
+
format: 'date-time',
|
|
24744
|
+
type: 'string',
|
|
24745
|
+
},
|
|
24746
|
+
error_code: {
|
|
24747
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
24748
|
+
enum: ['provider_issue'],
|
|
24749
|
+
type: 'string',
|
|
24750
|
+
},
|
|
24751
|
+
is_access_code_error: {
|
|
24752
|
+
description: 'Indicates that this is an access code error.',
|
|
24753
|
+
enum: [true],
|
|
24754
|
+
type: 'boolean',
|
|
24755
|
+
},
|
|
24756
|
+
message: {
|
|
24757
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
24758
|
+
type: 'string',
|
|
24759
|
+
},
|
|
24760
|
+
},
|
|
24761
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24762
|
+
type: 'object',
|
|
24763
|
+
},
|
|
24764
|
+
{
|
|
24765
|
+
deprecated: true,
|
|
24588
24766
|
description: 'Failed to set code on SmartThings device.',
|
|
24589
24767
|
properties: {
|
|
24590
24768
|
created_at: {
|
|
@@ -24609,8 +24787,10 @@ const openapi = {
|
|
|
24609
24787
|
},
|
|
24610
24788
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24611
24789
|
type: 'object',
|
|
24790
|
+
'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
|
|
24612
24791
|
},
|
|
24613
24792
|
{
|
|
24793
|
+
deprecated: true,
|
|
24614
24794
|
description: 'Failed to set code after multiple retries.',
|
|
24615
24795
|
properties: {
|
|
24616
24796
|
created_at: {
|
|
@@ -24637,6 +24817,7 @@ const openapi = {
|
|
|
24637
24817
|
},
|
|
24638
24818
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24639
24819
|
type: 'object',
|
|
24820
|
+
'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
|
|
24640
24821
|
},
|
|
24641
24822
|
{
|
|
24642
24823
|
description: 'Failed to set code on device.',
|
|
@@ -24863,6 +25044,11 @@ const openapi = {
|
|
|
24863
25044
|
{
|
|
24864
25045
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
24865
25046
|
properties: {
|
|
25047
|
+
change_type: {
|
|
25048
|
+
description: "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.",
|
|
25049
|
+
enum: ['modified', 'removed'],
|
|
25050
|
+
type: 'string',
|
|
25051
|
+
},
|
|
24866
25052
|
created_at: {
|
|
24867
25053
|
description: 'Date and time at which Seam created the error.',
|
|
24868
25054
|
format: 'date-time',
|
|
@@ -24882,11 +25068,36 @@ const openapi = {
|
|
|
24882
25068
|
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
24883
25069
|
type: 'string',
|
|
24884
25070
|
},
|
|
25071
|
+
modified_fields: {
|
|
25072
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
25073
|
+
items: {
|
|
25074
|
+
properties: {
|
|
25075
|
+
field: {
|
|
25076
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
25077
|
+
type: 'string',
|
|
25078
|
+
},
|
|
25079
|
+
from: {
|
|
25080
|
+
description: 'The previous value of the field.',
|
|
25081
|
+
nullable: true,
|
|
25082
|
+
type: 'string',
|
|
25083
|
+
},
|
|
25084
|
+
to: {
|
|
25085
|
+
description: 'The new value of the field.',
|
|
25086
|
+
nullable: true,
|
|
25087
|
+
type: 'string',
|
|
25088
|
+
},
|
|
25089
|
+
},
|
|
25090
|
+
required: ['field', 'from', 'to'],
|
|
25091
|
+
type: 'object',
|
|
25092
|
+
},
|
|
25093
|
+
type: 'array',
|
|
25094
|
+
},
|
|
24885
25095
|
},
|
|
24886
25096
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24887
25097
|
type: 'object',
|
|
24888
25098
|
},
|
|
24889
25099
|
{
|
|
25100
|
+
deprecated: true,
|
|
24890
25101
|
description: 'Invalid code length for August lock.',
|
|
24891
25102
|
properties: {
|
|
24892
25103
|
created_at: {
|
|
@@ -24911,8 +25122,10 @@ const openapi = {
|
|
|
24911
25122
|
},
|
|
24912
25123
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24913
25124
|
type: 'object',
|
|
25125
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
24914
25126
|
},
|
|
24915
25127
|
{
|
|
25128
|
+
deprecated: true,
|
|
24916
25129
|
description: 'August lock is missing a keypad.',
|
|
24917
25130
|
properties: {
|
|
24918
25131
|
created_at: {
|
|
@@ -24937,8 +25150,10 @@ const openapi = {
|
|
|
24937
25150
|
},
|
|
24938
25151
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24939
25152
|
type: 'object',
|
|
25153
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
24940
25154
|
},
|
|
24941
25155
|
{
|
|
25156
|
+
deprecated: true,
|
|
24942
25157
|
description: 'August lock is temporarily offline.',
|
|
24943
25158
|
properties: {
|
|
24944
25159
|
created_at: {
|
|
@@ -24963,8 +25178,36 @@ const openapi = {
|
|
|
24963
25178
|
},
|
|
24964
25179
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24965
25180
|
type: 'object',
|
|
25181
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
25182
|
+
},
|
|
25183
|
+
{
|
|
25184
|
+
description: 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
25185
|
+
properties: {
|
|
25186
|
+
created_at: {
|
|
25187
|
+
description: 'Date and time at which Seam created the error.',
|
|
25188
|
+
format: 'date-time',
|
|
25189
|
+
type: 'string',
|
|
25190
|
+
},
|
|
25191
|
+
error_code: {
|
|
25192
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
25193
|
+
enum: ['access_code_inactive'],
|
|
25194
|
+
type: 'string',
|
|
25195
|
+
},
|
|
25196
|
+
is_access_code_error: {
|
|
25197
|
+
description: 'Indicates that this is an access code error.',
|
|
25198
|
+
enum: [true],
|
|
25199
|
+
type: 'boolean',
|
|
25200
|
+
},
|
|
25201
|
+
message: {
|
|
25202
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
25203
|
+
type: 'string',
|
|
25204
|
+
},
|
|
25205
|
+
},
|
|
25206
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
25207
|
+
type: 'object',
|
|
24966
25208
|
},
|
|
24967
25209
|
{
|
|
25210
|
+
deprecated: true,
|
|
24968
25211
|
description: 'Salto site user is not subscribed.',
|
|
24969
25212
|
properties: {
|
|
24970
25213
|
created_at: {
|
|
@@ -24989,6 +25232,7 @@ const openapi = {
|
|
|
24989
25232
|
},
|
|
24990
25233
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24991
25234
|
type: 'object',
|
|
25235
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
24992
25236
|
},
|
|
24993
25237
|
{
|
|
24994
25238
|
deprecated: true,
|
|
@@ -25047,6 +25291,7 @@ const openapi = {
|
|
|
25047
25291
|
'x-deprecated': 'Use `duplicate_code_on_device` instead.',
|
|
25048
25292
|
},
|
|
25049
25293
|
{
|
|
25294
|
+
deprecated: true,
|
|
25050
25295
|
description: 'No Dormakaba Oracode user levels configured for the requested time range.',
|
|
25051
25296
|
properties: {
|
|
25052
25297
|
created_at: {
|
|
@@ -25071,8 +25316,10 @@ const openapi = {
|
|
|
25071
25316
|
},
|
|
25072
25317
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
25073
25318
|
type: 'object',
|
|
25319
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
25074
25320
|
},
|
|
25075
25321
|
{
|
|
25322
|
+
deprecated: true,
|
|
25076
25323
|
description: '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.',
|
|
25077
25324
|
properties: {
|
|
25078
25325
|
created_at: {
|
|
@@ -25097,8 +25344,10 @@ const openapi = {
|
|
|
25097
25344
|
},
|
|
25098
25345
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
25099
25346
|
type: 'object',
|
|
25347
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
25100
25348
|
},
|
|
25101
25349
|
{
|
|
25350
|
+
deprecated: true,
|
|
25102
25351
|
description: 'KeyNest locker is not supported.',
|
|
25103
25352
|
properties: {
|
|
25104
25353
|
created_at: {
|
|
@@ -25123,6 +25372,7 @@ const openapi = {
|
|
|
25123
25372
|
},
|
|
25124
25373
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
25125
25374
|
type: 'object',
|
|
25375
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
25126
25376
|
},
|
|
25127
25377
|
{
|
|
25128
25378
|
description: 'This access code was overridden on the device by a newer access code programmed to the same slot.',
|
|
@@ -25683,6 +25933,27 @@ const openapi = {
|
|
|
25683
25933
|
description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
25684
25934
|
discriminator: { propertyName: 'warning_code' },
|
|
25685
25935
|
oneOf: [
|
|
25936
|
+
{
|
|
25937
|
+
description: 'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
|
|
25938
|
+
properties: {
|
|
25939
|
+
created_at: {
|
|
25940
|
+
description: 'Date and time at which Seam created the warning.',
|
|
25941
|
+
format: 'date-time',
|
|
25942
|
+
type: 'string',
|
|
25943
|
+
},
|
|
25944
|
+
message: {
|
|
25945
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
25946
|
+
type: 'string',
|
|
25947
|
+
},
|
|
25948
|
+
warning_code: {
|
|
25949
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
25950
|
+
enum: ['provider_issue'],
|
|
25951
|
+
type: 'string',
|
|
25952
|
+
},
|
|
25953
|
+
},
|
|
25954
|
+
required: ['message', 'warning_code'],
|
|
25955
|
+
type: 'object',
|
|
25956
|
+
},
|
|
25686
25957
|
{
|
|
25687
25958
|
description: 'Failed to set code on SmartThings device.',
|
|
25688
25959
|
properties: {
|
|
@@ -25728,6 +25999,7 @@ const openapi = {
|
|
|
25728
25999
|
'x-deprecated': 'Use `duplicate_code_on_device` error instead.',
|
|
25729
26000
|
},
|
|
25730
26001
|
{
|
|
26002
|
+
deprecated: true,
|
|
25731
26003
|
description: 'Received an error when attempting to create this code.',
|
|
25732
26004
|
properties: {
|
|
25733
26005
|
created_at: {
|
|
@@ -25747,6 +26019,7 @@ const openapi = {
|
|
|
25747
26019
|
},
|
|
25748
26020
|
required: ['message', 'warning_code'],
|
|
25749
26021
|
type: 'object',
|
|
26022
|
+
'x-deprecated': 'Use `provider_issue` instead.',
|
|
25750
26023
|
},
|
|
25751
26024
|
{
|
|
25752
26025
|
description: "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.",
|
|
@@ -25772,6 +26045,11 @@ const openapi = {
|
|
|
25772
26045
|
{
|
|
25773
26046
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
25774
26047
|
properties: {
|
|
26048
|
+
change_type: {
|
|
26049
|
+
description: "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.",
|
|
26050
|
+
enum: ['modified', 'removed'],
|
|
26051
|
+
type: 'string',
|
|
26052
|
+
},
|
|
25775
26053
|
created_at: {
|
|
25776
26054
|
description: 'Date and time at which Seam created the warning.',
|
|
25777
26055
|
format: 'date-time',
|
|
@@ -25781,6 +26059,30 @@ const openapi = {
|
|
|
25781
26059
|
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
25782
26060
|
type: 'string',
|
|
25783
26061
|
},
|
|
26062
|
+
modified_fields: {
|
|
26063
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
26064
|
+
items: {
|
|
26065
|
+
properties: {
|
|
26066
|
+
field: {
|
|
26067
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
26068
|
+
type: 'string',
|
|
26069
|
+
},
|
|
26070
|
+
from: {
|
|
26071
|
+
description: 'The previous value of the field.',
|
|
26072
|
+
nullable: true,
|
|
26073
|
+
type: 'string',
|
|
26074
|
+
},
|
|
26075
|
+
to: {
|
|
26076
|
+
description: 'The new value of the field.',
|
|
26077
|
+
nullable: true,
|
|
26078
|
+
type: 'string',
|
|
26079
|
+
},
|
|
26080
|
+
},
|
|
26081
|
+
required: ['field', 'from', 'to'],
|
|
26082
|
+
type: 'object',
|
|
26083
|
+
},
|
|
26084
|
+
type: 'array',
|
|
26085
|
+
},
|
|
25784
26086
|
warning_code: {
|
|
25785
26087
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
25786
26088
|
enum: ['code_modified_external_to_seam'],
|