@seamapi/types 1.871.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.
@@ -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.',
@@ -414,6 +444,7 @@ const openapi = {
414
444
  type: 'object',
415
445
  },
416
446
  {
447
+ deprecated: true,
417
448
  description: 'Invalid code length for August lock.',
418
449
  properties: {
419
450
  created_at: {
@@ -438,8 +469,10 @@ const openapi = {
438
469
  },
439
470
  required: ['message', 'is_access_code_error', 'error_code'],
440
471
  type: 'object',
472
+ 'x-deprecated': 'Use `provider_issue` instead.',
441
473
  },
442
474
  {
475
+ deprecated: true,
443
476
  description: 'August lock is missing a keypad.',
444
477
  properties: {
445
478
  created_at: {
@@ -464,8 +497,10 @@ const openapi = {
464
497
  },
465
498
  required: ['message', 'is_access_code_error', 'error_code'],
466
499
  type: 'object',
500
+ 'x-deprecated': 'Use `provider_issue` instead.',
467
501
  },
468
502
  {
503
+ deprecated: true,
469
504
  description: 'August lock is temporarily offline.',
470
505
  properties: {
471
506
  created_at: {
@@ -490,8 +525,36 @@ const openapi = {
490
525
  },
491
526
  required: ['message', 'is_access_code_error', 'error_code'],
492
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',
493
555
  },
494
556
  {
557
+ deprecated: true,
495
558
  description: 'Salto site user is not subscribed.',
496
559
  properties: {
497
560
  created_at: {
@@ -516,6 +579,7 @@ const openapi = {
516
579
  },
517
580
  required: ['message', 'is_access_code_error', 'error_code'],
518
581
  type: 'object',
582
+ 'x-deprecated': 'Use `access_code_inactive` instead.',
519
583
  },
520
584
  {
521
585
  deprecated: true,
@@ -574,6 +638,7 @@ const openapi = {
574
638
  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
575
639
  },
576
640
  {
641
+ deprecated: true,
577
642
  description: 'No Dormakaba Oracode user levels configured for the requested time range.',
578
643
  properties: {
579
644
  created_at: {
@@ -598,8 +663,10 @@ const openapi = {
598
663
  },
599
664
  required: ['message', 'is_access_code_error', 'error_code'],
600
665
  type: 'object',
666
+ 'x-deprecated': 'Use `provider_issue` instead.',
601
667
  },
602
668
  {
669
+ deprecated: true,
603
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.',
604
671
  properties: {
605
672
  created_at: {
@@ -624,8 +691,10 @@ const openapi = {
624
691
  },
625
692
  required: ['message', 'is_access_code_error', 'error_code'],
626
693
  type: 'object',
694
+ 'x-deprecated': 'Use `provider_issue` instead.',
627
695
  },
628
696
  {
697
+ deprecated: true,
629
698
  description: 'KeyNest locker is not supported.',
630
699
  properties: {
631
700
  created_at: {
@@ -650,6 +719,7 @@ const openapi = {
650
719
  },
651
720
  required: ['message', 'is_access_code_error', 'error_code'],
652
721
  type: 'object',
722
+ 'x-deprecated': 'Use `provider_issue` instead.',
653
723
  },
654
724
  {
655
725
  description: 'This access code was overridden on the device by a newer access code programmed to the same slot.',
@@ -1493,6 +1563,27 @@ const openapi = {
1493
1563
  description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
1494
1564
  discriminator: { propertyName: 'warning_code' },
1495
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
+ },
1496
1587
  {
1497
1588
  description: 'Failed to set code on SmartThings device.',
1498
1589
  properties: {
@@ -1538,6 +1629,7 @@ const openapi = {
1538
1629
  'x-deprecated': 'Use `duplicate_code_on_device` error instead.',
1539
1630
  },
1540
1631
  {
1632
+ deprecated: true,
1541
1633
  description: 'Received an error when attempting to create this code.',
1542
1634
  properties: {
1543
1635
  created_at: {
@@ -1557,6 +1649,7 @@ const openapi = {
1557
1649
  },
1558
1650
  required: ['message', 'warning_code'],
1559
1651
  type: 'object',
1652
+ 'x-deprecated': 'Use `provider_issue` instead.',
1560
1653
  },
1561
1654
  {
1562
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.",
@@ -24643,6 +24736,33 @@ const openapi = {
24643
24736
  discriminator: { propertyName: 'error_code' },
24644
24737
  oneOf: [
24645
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,
24646
24766
  description: 'Failed to set code on SmartThings device.',
24647
24767
  properties: {
24648
24768
  created_at: {
@@ -24667,8 +24787,10 @@ const openapi = {
24667
24787
  },
24668
24788
  required: ['message', 'is_access_code_error', 'error_code'],
24669
24789
  type: 'object',
24790
+ 'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
24670
24791
  },
24671
24792
  {
24793
+ deprecated: true,
24672
24794
  description: 'Failed to set code after multiple retries.',
24673
24795
  properties: {
24674
24796
  created_at: {
@@ -24695,6 +24817,7 @@ const openapi = {
24695
24817
  },
24696
24818
  required: ['message', 'is_access_code_error', 'error_code'],
24697
24819
  type: 'object',
24820
+ 'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
24698
24821
  },
24699
24822
  {
24700
24823
  description: 'Failed to set code on device.',
@@ -24974,6 +25097,7 @@ const openapi = {
24974
25097
  type: 'object',
24975
25098
  },
24976
25099
  {
25100
+ deprecated: true,
24977
25101
  description: 'Invalid code length for August lock.',
24978
25102
  properties: {
24979
25103
  created_at: {
@@ -24998,8 +25122,10 @@ const openapi = {
24998
25122
  },
24999
25123
  required: ['message', 'is_access_code_error', 'error_code'],
25000
25124
  type: 'object',
25125
+ 'x-deprecated': 'Use `provider_issue` instead.',
25001
25126
  },
25002
25127
  {
25128
+ deprecated: true,
25003
25129
  description: 'August lock is missing a keypad.',
25004
25130
  properties: {
25005
25131
  created_at: {
@@ -25024,8 +25150,10 @@ const openapi = {
25024
25150
  },
25025
25151
  required: ['message', 'is_access_code_error', 'error_code'],
25026
25152
  type: 'object',
25153
+ 'x-deprecated': 'Use `provider_issue` instead.',
25027
25154
  },
25028
25155
  {
25156
+ deprecated: true,
25029
25157
  description: 'August lock is temporarily offline.',
25030
25158
  properties: {
25031
25159
  created_at: {
@@ -25050,8 +25178,36 @@ const openapi = {
25050
25178
  },
25051
25179
  required: ['message', 'is_access_code_error', 'error_code'],
25052
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',
25053
25208
  },
25054
25209
  {
25210
+ deprecated: true,
25055
25211
  description: 'Salto site user is not subscribed.',
25056
25212
  properties: {
25057
25213
  created_at: {
@@ -25076,6 +25232,7 @@ const openapi = {
25076
25232
  },
25077
25233
  required: ['message', 'is_access_code_error', 'error_code'],
25078
25234
  type: 'object',
25235
+ 'x-deprecated': 'Use `access_code_inactive` instead.',
25079
25236
  },
25080
25237
  {
25081
25238
  deprecated: true,
@@ -25134,6 +25291,7 @@ const openapi = {
25134
25291
  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
25135
25292
  },
25136
25293
  {
25294
+ deprecated: true,
25137
25295
  description: 'No Dormakaba Oracode user levels configured for the requested time range.',
25138
25296
  properties: {
25139
25297
  created_at: {
@@ -25158,8 +25316,10 @@ const openapi = {
25158
25316
  },
25159
25317
  required: ['message', 'is_access_code_error', 'error_code'],
25160
25318
  type: 'object',
25319
+ 'x-deprecated': 'Use `provider_issue` instead.',
25161
25320
  },
25162
25321
  {
25322
+ deprecated: true,
25163
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.',
25164
25324
  properties: {
25165
25325
  created_at: {
@@ -25184,8 +25344,10 @@ const openapi = {
25184
25344
  },
25185
25345
  required: ['message', 'is_access_code_error', 'error_code'],
25186
25346
  type: 'object',
25347
+ 'x-deprecated': 'Use `provider_issue` instead.',
25187
25348
  },
25188
25349
  {
25350
+ deprecated: true,
25189
25351
  description: 'KeyNest locker is not supported.',
25190
25352
  properties: {
25191
25353
  created_at: {
@@ -25210,6 +25372,7 @@ const openapi = {
25210
25372
  },
25211
25373
  required: ['message', 'is_access_code_error', 'error_code'],
25212
25374
  type: 'object',
25375
+ 'x-deprecated': 'Use `provider_issue` instead.',
25213
25376
  },
25214
25377
  {
25215
25378
  description: 'This access code was overridden on the device by a newer access code programmed to the same slot.',
@@ -25770,6 +25933,27 @@ const openapi = {
25770
25933
  description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
25771
25934
  discriminator: { propertyName: 'warning_code' },
25772
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
+ },
25773
25957
  {
25774
25958
  description: 'Failed to set code on SmartThings device.',
25775
25959
  properties: {
@@ -25815,6 +25999,7 @@ const openapi = {
25815
25999
  'x-deprecated': 'Use `duplicate_code_on_device` error instead.',
25816
26000
  },
25817
26001
  {
26002
+ deprecated: true,
25818
26003
  description: 'Received an error when attempting to create this code.',
25819
26004
  properties: {
25820
26005
  created_at: {
@@ -25834,6 +26019,7 @@ const openapi = {
25834
26019
  },
25835
26020
  required: ['message', 'warning_code'],
25836
26021
  type: 'object',
26022
+ 'x-deprecated': 'Use `provider_issue` instead.',
25837
26023
  },
25838
26024
  {
25839
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.",