@seamapi/types 1.871.0 → 1.873.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.",
@@ -3997,6 +4090,10 @@ const openapi = {
3997
4090
  },
3998
4091
  type: 'object',
3999
4092
  },
4093
+ is_locked: {
4094
+ description: 'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
4095
+ type: 'boolean',
4096
+ },
4000
4097
  latch_metadata: {
4001
4098
  description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
4002
4099
  properties: {
@@ -4217,6 +4314,27 @@ const openapi = {
4217
4314
  required: ['created_at', 'message', 'warning_code'],
4218
4315
  type: 'object',
4219
4316
  },
4317
+ {
4318
+ description: 'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
4319
+ properties: {
4320
+ created_at: {
4321
+ description: 'Date and time at which Seam created the warning.',
4322
+ format: 'date-time',
4323
+ type: 'string',
4324
+ },
4325
+ message: {
4326
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
4327
+ type: 'string',
4328
+ },
4329
+ warning_code: {
4330
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4331
+ enum: ['salto_ks_privacy_mode'],
4332
+ type: 'string',
4333
+ },
4334
+ },
4335
+ required: ['created_at', 'message', 'warning_code'],
4336
+ type: 'object',
4337
+ },
4220
4338
  ],
4221
4339
  },
4222
4340
  type: 'array',
@@ -23412,6 +23530,10 @@ const openapi = {
23412
23530
  },
23413
23531
  type: 'object',
23414
23532
  },
23533
+ is_locked: {
23534
+ description: 'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
23535
+ type: 'boolean',
23536
+ },
23415
23537
  latch_metadata: {
23416
23538
  description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
23417
23539
  properties: {
@@ -23646,6 +23768,31 @@ const openapi = {
23646
23768
  ],
23647
23769
  type: 'object',
23648
23770
  },
23771
+ {
23772
+ description: 'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
23773
+ properties: {
23774
+ created_at: {
23775
+ description: 'Date and time at which Seam created the warning.',
23776
+ format: 'date-time',
23777
+ type: 'string',
23778
+ },
23779
+ message: {
23780
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
23781
+ type: 'string',
23782
+ },
23783
+ warning_code: {
23784
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
23785
+ enum: ['salto_ks_privacy_mode'],
23786
+ type: 'string',
23787
+ },
23788
+ },
23789
+ required: [
23790
+ 'created_at',
23791
+ 'message',
23792
+ 'warning_code',
23793
+ ],
23794
+ type: 'object',
23795
+ },
23649
23796
  ],
23650
23797
  },
23651
23798
  type: 'array',
@@ -24643,6 +24790,33 @@ const openapi = {
24643
24790
  discriminator: { propertyName: 'error_code' },
24644
24791
  oneOf: [
24645
24792
  {
24793
+ description: 'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
24794
+ properties: {
24795
+ created_at: {
24796
+ description: 'Date and time at which Seam created the error.',
24797
+ format: 'date-time',
24798
+ type: 'string',
24799
+ },
24800
+ error_code: {
24801
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
24802
+ enum: ['provider_issue'],
24803
+ type: 'string',
24804
+ },
24805
+ is_access_code_error: {
24806
+ description: 'Indicates that this is an access code error.',
24807
+ enum: [true],
24808
+ type: 'boolean',
24809
+ },
24810
+ message: {
24811
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
24812
+ type: 'string',
24813
+ },
24814
+ },
24815
+ required: ['message', 'is_access_code_error', 'error_code'],
24816
+ type: 'object',
24817
+ },
24818
+ {
24819
+ deprecated: true,
24646
24820
  description: 'Failed to set code on SmartThings device.',
24647
24821
  properties: {
24648
24822
  created_at: {
@@ -24667,8 +24841,10 @@ const openapi = {
24667
24841
  },
24668
24842
  required: ['message', 'is_access_code_error', 'error_code'],
24669
24843
  type: 'object',
24844
+ 'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
24670
24845
  },
24671
24846
  {
24847
+ deprecated: true,
24672
24848
  description: 'Failed to set code after multiple retries.',
24673
24849
  properties: {
24674
24850
  created_at: {
@@ -24695,6 +24871,7 @@ const openapi = {
24695
24871
  },
24696
24872
  required: ['message', 'is_access_code_error', 'error_code'],
24697
24873
  type: 'object',
24874
+ 'x-deprecated': 'Handled by the generic `failed_to_set_on_device` system.',
24698
24875
  },
24699
24876
  {
24700
24877
  description: 'Failed to set code on device.',
@@ -24974,6 +25151,7 @@ const openapi = {
24974
25151
  type: 'object',
24975
25152
  },
24976
25153
  {
25154
+ deprecated: true,
24977
25155
  description: 'Invalid code length for August lock.',
24978
25156
  properties: {
24979
25157
  created_at: {
@@ -24998,8 +25176,10 @@ const openapi = {
24998
25176
  },
24999
25177
  required: ['message', 'is_access_code_error', 'error_code'],
25000
25178
  type: 'object',
25179
+ 'x-deprecated': 'Use `provider_issue` instead.',
25001
25180
  },
25002
25181
  {
25182
+ deprecated: true,
25003
25183
  description: 'August lock is missing a keypad.',
25004
25184
  properties: {
25005
25185
  created_at: {
@@ -25024,8 +25204,10 @@ const openapi = {
25024
25204
  },
25025
25205
  required: ['message', 'is_access_code_error', 'error_code'],
25026
25206
  type: 'object',
25207
+ 'x-deprecated': 'Use `provider_issue` instead.',
25027
25208
  },
25028
25209
  {
25210
+ deprecated: true,
25029
25211
  description: 'August lock is temporarily offline.',
25030
25212
  properties: {
25031
25213
  created_at: {
@@ -25050,8 +25232,36 @@ const openapi = {
25050
25232
  },
25051
25233
  required: ['message', 'is_access_code_error', 'error_code'],
25052
25234
  type: 'object',
25235
+ 'x-deprecated': 'Use `provider_issue` instead.',
25053
25236
  },
25054
25237
  {
25238
+ description: 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
25239
+ properties: {
25240
+ created_at: {
25241
+ description: 'Date and time at which Seam created the error.',
25242
+ format: 'date-time',
25243
+ type: 'string',
25244
+ },
25245
+ error_code: {
25246
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
25247
+ enum: ['access_code_inactive'],
25248
+ type: 'string',
25249
+ },
25250
+ is_access_code_error: {
25251
+ description: 'Indicates that this is an access code error.',
25252
+ enum: [true],
25253
+ type: 'boolean',
25254
+ },
25255
+ message: {
25256
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
25257
+ type: 'string',
25258
+ },
25259
+ },
25260
+ required: ['message', 'is_access_code_error', 'error_code'],
25261
+ type: 'object',
25262
+ },
25263
+ {
25264
+ deprecated: true,
25055
25265
  description: 'Salto site user is not subscribed.',
25056
25266
  properties: {
25057
25267
  created_at: {
@@ -25076,6 +25286,7 @@ const openapi = {
25076
25286
  },
25077
25287
  required: ['message', 'is_access_code_error', 'error_code'],
25078
25288
  type: 'object',
25289
+ 'x-deprecated': 'Use `access_code_inactive` instead.',
25079
25290
  },
25080
25291
  {
25081
25292
  deprecated: true,
@@ -25134,6 +25345,7 @@ const openapi = {
25134
25345
  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
25135
25346
  },
25136
25347
  {
25348
+ deprecated: true,
25137
25349
  description: 'No Dormakaba Oracode user levels configured for the requested time range.',
25138
25350
  properties: {
25139
25351
  created_at: {
@@ -25158,8 +25370,10 @@ const openapi = {
25158
25370
  },
25159
25371
  required: ['message', 'is_access_code_error', 'error_code'],
25160
25372
  type: 'object',
25373
+ 'x-deprecated': 'Use `provider_issue` instead.',
25161
25374
  },
25162
25375
  {
25376
+ deprecated: true,
25163
25377
  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
25378
  properties: {
25165
25379
  created_at: {
@@ -25184,8 +25398,10 @@ const openapi = {
25184
25398
  },
25185
25399
  required: ['message', 'is_access_code_error', 'error_code'],
25186
25400
  type: 'object',
25401
+ 'x-deprecated': 'Use `provider_issue` instead.',
25187
25402
  },
25188
25403
  {
25404
+ deprecated: true,
25189
25405
  description: 'KeyNest locker is not supported.',
25190
25406
  properties: {
25191
25407
  created_at: {
@@ -25210,6 +25426,7 @@ const openapi = {
25210
25426
  },
25211
25427
  required: ['message', 'is_access_code_error', 'error_code'],
25212
25428
  type: 'object',
25429
+ 'x-deprecated': 'Use `provider_issue` instead.',
25213
25430
  },
25214
25431
  {
25215
25432
  description: 'This access code was overridden on the device by a newer access code programmed to the same slot.',
@@ -25770,6 +25987,27 @@ const openapi = {
25770
25987
  description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
25771
25988
  discriminator: { propertyName: 'warning_code' },
25772
25989
  oneOf: [
25990
+ {
25991
+ description: 'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
25992
+ properties: {
25993
+ created_at: {
25994
+ description: 'Date and time at which Seam created the warning.',
25995
+ format: 'date-time',
25996
+ type: 'string',
25997
+ },
25998
+ message: {
25999
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
26000
+ type: 'string',
26001
+ },
26002
+ warning_code: {
26003
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
26004
+ enum: ['provider_issue'],
26005
+ type: 'string',
26006
+ },
26007
+ },
26008
+ required: ['message', 'warning_code'],
26009
+ type: 'object',
26010
+ },
25773
26011
  {
25774
26012
  description: 'Failed to set code on SmartThings device.',
25775
26013
  properties: {
@@ -25815,6 +26053,7 @@ const openapi = {
25815
26053
  'x-deprecated': 'Use `duplicate_code_on_device` error instead.',
25816
26054
  },
25817
26055
  {
26056
+ deprecated: true,
25818
26057
  description: 'Received an error when attempting to create this code.',
25819
26058
  properties: {
25820
26059
  created_at: {
@@ -25834,6 +26073,7 @@ const openapi = {
25834
26073
  },
25835
26074
  required: ['message', 'warning_code'],
25836
26075
  type: 'object',
26076
+ 'x-deprecated': 'Use `provider_issue` instead.',
25837
26077
  },
25838
26078
  {
25839
26079
  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.",