@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.
Files changed (22) hide show
  1. package/dist/connect.cjs +367 -30
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +825 -0
  4. package/dist/index.cjs +367 -30
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +210 -10
  7. package/lib/seam/connect/models/access-codes/managed-access-code.js +85 -10
  8. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  9. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +73 -0
  10. package/lib/seam/connect/models/acs/acs-entrance.d.ts +48 -0
  11. package/lib/seam/connect/models/acs/acs-entrance.js +13 -0
  12. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  13. package/lib/seam/connect/models/batch.d.ts +236 -0
  14. package/lib/seam/connect/models/phones/phone-session.d.ts +98 -0
  15. package/lib/seam/connect/openapi.js +240 -0
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +374 -0
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +110 -10
  20. package/src/lib/seam/connect/models/acs/acs-entrance.ts +18 -0
  21. package/src/lib/seam/connect/openapi.ts +282 -0
  22. package/src/lib/seam/connect/route-types.ts +418 -0
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -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.',
@@ -492,6 +529,7 @@ const openapi: OpenAPISpec = {
492
529
  type: 'object',
493
530
  },
494
531
  {
532
+ deprecated: true,
495
533
  description: 'Invalid code length for August lock.',
496
534
  properties: {
497
535
  created_at: {
@@ -520,8 +558,10 @@ const openapi: OpenAPISpec = {
520
558
  },
521
559
  required: ['message', 'is_access_code_error', 'error_code'],
522
560
  type: 'object',
561
+ 'x-deprecated': 'Use `provider_issue` instead.',
523
562
  },
524
563
  {
564
+ deprecated: true,
525
565
  description: 'August lock is missing a keypad.',
526
566
  properties: {
527
567
  created_at: {
@@ -550,8 +590,10 @@ const openapi: OpenAPISpec = {
550
590
  },
551
591
  required: ['message', 'is_access_code_error', 'error_code'],
552
592
  type: 'object',
593
+ 'x-deprecated': 'Use `provider_issue` instead.',
553
594
  },
554
595
  {
596
+ deprecated: true,
555
597
  description: 'August lock is temporarily offline.',
556
598
  properties: {
557
599
  created_at: {
@@ -580,8 +622,41 @@ const openapi: OpenAPISpec = {
580
622
  },
581
623
  required: ['message', 'is_access_code_error', 'error_code'],
582
624
  type: 'object',
625
+ 'x-deprecated': 'Use `provider_issue` instead.',
583
626
  },
584
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',
657
+ },
658
+ {
659
+ deprecated: true,
585
660
  description: 'Salto site user is not subscribed.',
586
661
  properties: {
587
662
  created_at: {
@@ -610,6 +685,7 @@ const openapi: OpenAPISpec = {
610
685
  },
611
686
  required: ['message', 'is_access_code_error', 'error_code'],
612
687
  type: 'object',
688
+ 'x-deprecated': 'Use `access_code_inactive` instead.',
613
689
  },
614
690
  {
615
691
  deprecated: true,
@@ -676,6 +752,7 @@ const openapi: OpenAPISpec = {
676
752
  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
677
753
  },
678
754
  {
755
+ deprecated: true,
679
756
  description:
680
757
  'No Dormakaba Oracode user levels configured for the requested time range.',
681
758
  properties: {
@@ -705,8 +782,10 @@ const openapi: OpenAPISpec = {
705
782
  },
706
783
  required: ['message', 'is_access_code_error', 'error_code'],
707
784
  type: 'object',
785
+ 'x-deprecated': 'Use `provider_issue` instead.',
708
786
  },
709
787
  {
788
+ deprecated: true,
710
789
  description:
711
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.',
712
791
  properties: {
@@ -736,8 +815,10 @@ const openapi: OpenAPISpec = {
736
815
  },
737
816
  required: ['message', 'is_access_code_error', 'error_code'],
738
817
  type: 'object',
818
+ 'x-deprecated': 'Use `provider_issue` instead.',
739
819
  },
740
820
  {
821
+ deprecated: true,
741
822
  description: 'KeyNest locker is not supported.',
742
823
  properties: {
743
824
  created_at: {
@@ -766,6 +847,7 @@ const openapi: OpenAPISpec = {
766
847
  },
767
848
  required: ['message', 'is_access_code_error', 'error_code'],
768
849
  type: 'object',
850
+ 'x-deprecated': 'Use `provider_issue` instead.',
769
851
  },
770
852
  {
771
853
  description:
@@ -1719,6 +1801,31 @@ const openapi: OpenAPISpec = {
1719
1801
  'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
1720
1802
  discriminator: { propertyName: 'warning_code' },
1721
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
+ },
1722
1829
  {
1723
1830
  description: 'Failed to set code on SmartThings device.',
1724
1831
  properties: {
@@ -1771,6 +1878,7 @@ const openapi: OpenAPISpec = {
1771
1878
  'Use `duplicate_code_on_device` error instead.',
1772
1879
  },
1773
1880
  {
1881
+ deprecated: true,
1774
1882
  description:
1775
1883
  'Received an error when attempting to create this code.',
1776
1884
  properties: {
@@ -1794,6 +1902,7 @@ const openapi: OpenAPISpec = {
1794
1902
  },
1795
1903
  required: ['message', 'warning_code'],
1796
1904
  type: 'object',
1905
+ 'x-deprecated': 'Use `provider_issue` instead.',
1797
1906
  },
1798
1907
  {
1799
1908
  description:
@@ -4541,6 +4650,11 @@ const openapi: OpenAPISpec = {
4541
4650
  },
4542
4651
  type: 'object',
4543
4652
  },
4653
+ is_locked: {
4654
+ description:
4655
+ 'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
4656
+ type: 'boolean',
4657
+ },
4544
4658
  latch_metadata: {
4545
4659
  description:
4546
4660
  'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -4793,6 +4907,31 @@ const openapi: OpenAPISpec = {
4793
4907
  required: ['created_at', 'message', 'warning_code'],
4794
4908
  type: 'object',
4795
4909
  },
4910
+ {
4911
+ description:
4912
+ '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.',
4913
+ properties: {
4914
+ created_at: {
4915
+ description:
4916
+ 'Date and time at which Seam created the warning.',
4917
+ format: 'date-time',
4918
+ type: 'string',
4919
+ },
4920
+ message: {
4921
+ description:
4922
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
4923
+ type: 'string',
4924
+ },
4925
+ warning_code: {
4926
+ description:
4927
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4928
+ enum: ['salto_ks_privacy_mode'],
4929
+ type: 'string',
4930
+ },
4931
+ },
4932
+ required: ['created_at', 'message', 'warning_code'],
4933
+ type: 'object',
4934
+ },
4796
4935
  ],
4797
4936
  },
4798
4937
  type: 'array',
@@ -26069,6 +26208,11 @@ const openapi: OpenAPISpec = {
26069
26208
  },
26070
26209
  type: 'object',
26071
26210
  },
26211
+ is_locked: {
26212
+ description:
26213
+ 'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
26214
+ type: 'boolean',
26215
+ },
26072
26216
  latch_metadata: {
26073
26217
  description:
26074
26218
  'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -26345,6 +26489,35 @@ const openapi: OpenAPISpec = {
26345
26489
  ],
26346
26490
  type: 'object',
26347
26491
  },
26492
+ {
26493
+ description:
26494
+ '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.',
26495
+ properties: {
26496
+ created_at: {
26497
+ description:
26498
+ 'Date and time at which Seam created the warning.',
26499
+ format: 'date-time',
26500
+ type: 'string',
26501
+ },
26502
+ message: {
26503
+ description:
26504
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
26505
+ type: 'string',
26506
+ },
26507
+ warning_code: {
26508
+ description:
26509
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
26510
+ enum: ['salto_ks_privacy_mode'],
26511
+ type: 'string',
26512
+ },
26513
+ },
26514
+ required: [
26515
+ 'created_at',
26516
+ 'message',
26517
+ 'warning_code',
26518
+ ],
26519
+ type: 'object',
26520
+ },
26348
26521
  ],
26349
26522
  },
26350
26523
  type: 'array',
@@ -27478,6 +27651,38 @@ const openapi: OpenAPISpec = {
27478
27651
  discriminator: { propertyName: 'error_code' },
27479
27652
  oneOf: [
27480
27653
  {
27654
+ description:
27655
+ 'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
27656
+ properties: {
27657
+ created_at: {
27658
+ description:
27659
+ 'Date and time at which Seam created the error.',
27660
+ format: 'date-time',
27661
+ type: 'string',
27662
+ },
27663
+ error_code: {
27664
+ description:
27665
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27666
+ enum: ['provider_issue'],
27667
+ type: 'string',
27668
+ },
27669
+ is_access_code_error: {
27670
+ description:
27671
+ 'Indicates that this is an access code error.',
27672
+ enum: [true],
27673
+ type: 'boolean',
27674
+ },
27675
+ message: {
27676
+ description:
27677
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27678
+ type: 'string',
27679
+ },
27680
+ },
27681
+ required: ['message', 'is_access_code_error', 'error_code'],
27682
+ type: 'object',
27683
+ },
27684
+ {
27685
+ deprecated: true,
27481
27686
  description: 'Failed to set code on SmartThings device.',
27482
27687
  properties: {
27483
27688
  created_at: {
@@ -27506,8 +27711,11 @@ const openapi: OpenAPISpec = {
27506
27711
  },
27507
27712
  required: ['message', 'is_access_code_error', 'error_code'],
27508
27713
  type: 'object',
27714
+ 'x-deprecated':
27715
+ 'Handled by the generic `failed_to_set_on_device` system.',
27509
27716
  },
27510
27717
  {
27718
+ deprecated: true,
27511
27719
  description: 'Failed to set code after multiple retries.',
27512
27720
  properties: {
27513
27721
  created_at: {
@@ -27538,6 +27746,8 @@ const openapi: OpenAPISpec = {
27538
27746
  },
27539
27747
  required: ['message', 'is_access_code_error', 'error_code'],
27540
27748
  type: 'object',
27749
+ 'x-deprecated':
27750
+ 'Handled by the generic `failed_to_set_on_device` system.',
27541
27751
  },
27542
27752
  {
27543
27753
  description: 'Failed to set code on device.',
@@ -27865,6 +28075,7 @@ const openapi: OpenAPISpec = {
27865
28075
  type: 'object',
27866
28076
  },
27867
28077
  {
28078
+ deprecated: true,
27868
28079
  description: 'Invalid code length for August lock.',
27869
28080
  properties: {
27870
28081
  created_at: {
@@ -27893,8 +28104,10 @@ const openapi: OpenAPISpec = {
27893
28104
  },
27894
28105
  required: ['message', 'is_access_code_error', 'error_code'],
27895
28106
  type: 'object',
28107
+ 'x-deprecated': 'Use `provider_issue` instead.',
27896
28108
  },
27897
28109
  {
28110
+ deprecated: true,
27898
28111
  description: 'August lock is missing a keypad.',
27899
28112
  properties: {
27900
28113
  created_at: {
@@ -27923,8 +28136,10 @@ const openapi: OpenAPISpec = {
27923
28136
  },
27924
28137
  required: ['message', 'is_access_code_error', 'error_code'],
27925
28138
  type: 'object',
28139
+ 'x-deprecated': 'Use `provider_issue` instead.',
27926
28140
  },
27927
28141
  {
28142
+ deprecated: true,
27928
28143
  description: 'August lock is temporarily offline.',
27929
28144
  properties: {
27930
28145
  created_at: {
@@ -27953,8 +28168,41 @@ const openapi: OpenAPISpec = {
27953
28168
  },
27954
28169
  required: ['message', 'is_access_code_error', 'error_code'],
27955
28170
  type: 'object',
28171
+ 'x-deprecated': 'Use `provider_issue` instead.',
28172
+ },
28173
+ {
28174
+ description:
28175
+ 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
28176
+ properties: {
28177
+ created_at: {
28178
+ description:
28179
+ 'Date and time at which Seam created the error.',
28180
+ format: 'date-time',
28181
+ type: 'string',
28182
+ },
28183
+ error_code: {
28184
+ description:
28185
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
28186
+ enum: ['access_code_inactive'],
28187
+ type: 'string',
28188
+ },
28189
+ is_access_code_error: {
28190
+ description:
28191
+ 'Indicates that this is an access code error.',
28192
+ enum: [true],
28193
+ type: 'boolean',
28194
+ },
28195
+ message: {
28196
+ description:
28197
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
28198
+ type: 'string',
28199
+ },
28200
+ },
28201
+ required: ['message', 'is_access_code_error', 'error_code'],
28202
+ type: 'object',
27956
28203
  },
27957
28204
  {
28205
+ deprecated: true,
27958
28206
  description: 'Salto site user is not subscribed.',
27959
28207
  properties: {
27960
28208
  created_at: {
@@ -27983,6 +28231,7 @@ const openapi: OpenAPISpec = {
27983
28231
  },
27984
28232
  required: ['message', 'is_access_code_error', 'error_code'],
27985
28233
  type: 'object',
28234
+ 'x-deprecated': 'Use `access_code_inactive` instead.',
27986
28235
  },
27987
28236
  {
27988
28237
  deprecated: true,
@@ -28049,6 +28298,7 @@ const openapi: OpenAPISpec = {
28049
28298
  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
28050
28299
  },
28051
28300
  {
28301
+ deprecated: true,
28052
28302
  description:
28053
28303
  'No Dormakaba Oracode user levels configured for the requested time range.',
28054
28304
  properties: {
@@ -28078,8 +28328,10 @@ const openapi: OpenAPISpec = {
28078
28328
  },
28079
28329
  required: ['message', 'is_access_code_error', 'error_code'],
28080
28330
  type: 'object',
28331
+ 'x-deprecated': 'Use `provider_issue` instead.',
28081
28332
  },
28082
28333
  {
28334
+ deprecated: true,
28083
28335
  description:
28084
28336
  '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.',
28085
28337
  properties: {
@@ -28109,8 +28361,10 @@ const openapi: OpenAPISpec = {
28109
28361
  },
28110
28362
  required: ['message', 'is_access_code_error', 'error_code'],
28111
28363
  type: 'object',
28364
+ 'x-deprecated': 'Use `provider_issue` instead.',
28112
28365
  },
28113
28366
  {
28367
+ deprecated: true,
28114
28368
  description: 'KeyNest locker is not supported.',
28115
28369
  properties: {
28116
28370
  created_at: {
@@ -28139,6 +28393,7 @@ const openapi: OpenAPISpec = {
28139
28393
  },
28140
28394
  required: ['message', 'is_access_code_error', 'error_code'],
28141
28395
  type: 'object',
28396
+ 'x-deprecated': 'Use `provider_issue` instead.',
28142
28397
  },
28143
28398
  {
28144
28399
  description:
@@ -28781,6 +29036,31 @@ const openapi: OpenAPISpec = {
28781
29036
  'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
28782
29037
  discriminator: { propertyName: 'warning_code' },
28783
29038
  oneOf: [
29039
+ {
29040
+ description:
29041
+ 'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
29042
+ properties: {
29043
+ created_at: {
29044
+ description:
29045
+ 'Date and time at which Seam created the warning.',
29046
+ format: 'date-time',
29047
+ type: 'string',
29048
+ },
29049
+ message: {
29050
+ description:
29051
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
29052
+ type: 'string',
29053
+ },
29054
+ warning_code: {
29055
+ description:
29056
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
29057
+ enum: ['provider_issue'],
29058
+ type: 'string',
29059
+ },
29060
+ },
29061
+ required: ['message', 'warning_code'],
29062
+ type: 'object',
29063
+ },
28784
29064
  {
28785
29065
  description: 'Failed to set code on SmartThings device.',
28786
29066
  properties: {
@@ -28833,6 +29113,7 @@ const openapi: OpenAPISpec = {
28833
29113
  'Use `duplicate_code_on_device` error instead.',
28834
29114
  },
28835
29115
  {
29116
+ deprecated: true,
28836
29117
  description:
28837
29118
  'Received an error when attempting to create this code.',
28838
29119
  properties: {
@@ -28856,6 +29137,7 @@ const openapi: OpenAPISpec = {
28856
29137
  },
28857
29138
  required: ['message', 'warning_code'],
28858
29139
  type: 'object',
29140
+ 'x-deprecated': 'Use `provider_issue` instead.',
28859
29141
  },
28860
29142
  {
28861
29143
  description: