@seamapi/types 1.922.0 → 1.923.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.
@@ -524,6 +524,45 @@ const openapi = {
524
524
  'x-resource-type': 'connected_account',
525
525
  'x-variant-group-key': 'locks',
526
526
  },
527
+ {
528
+ description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
529
+ properties: {
530
+ created_at: {
531
+ description: 'Date and time at which Seam created the error.',
532
+ format: 'date-time',
533
+ type: 'string',
534
+ },
535
+ error_code: {
536
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
537
+ enum: ['dormakaba_sites_disconnected'],
538
+ type: 'string',
539
+ },
540
+ is_connected_account_error: {
541
+ description: 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
542
+ enum: [true],
543
+ type: 'boolean',
544
+ },
545
+ is_device_error: {
546
+ description: 'Indicates that the error is not a device error.',
547
+ enum: [false],
548
+ type: 'boolean',
549
+ },
550
+ message: {
551
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
552
+ type: 'string',
553
+ },
554
+ },
555
+ required: [
556
+ 'message',
557
+ 'is_device_error',
558
+ 'created_at',
559
+ 'error_code',
560
+ 'is_connected_account_error',
561
+ ],
562
+ type: 'object',
563
+ 'x-resource-type': 'connected_account',
564
+ 'x-variant-group-key': 'locks',
565
+ },
527
566
  {
528
567
  deprecated: true,
529
568
  description: 'Indicates that the device is offline.',
@@ -788,6 +827,7 @@ const openapi = {
788
827
  type: 'object',
789
828
  'x-deprecated': 'Use `hub_disconnected` instead.',
790
829
  'x-resource-type': 'device',
830
+ 'x-variant-group-key': 'locks',
791
831
  },
792
832
  {
793
833
  description: 'Indicates that device credentials are missing.',
@@ -919,6 +959,7 @@ const openapi = {
919
959
  type: 'object',
920
960
  'x-deprecated': 'Use `hub_disconnected` instead.',
921
961
  'x-resource-type': 'device',
962
+ 'x-variant-group-key': 'locks',
922
963
  },
923
964
  {
924
965
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
@@ -950,36 +991,6 @@ const openapi = {
950
991
  type: 'object',
951
992
  'x-resource-type': 'connected_account',
952
993
  },
953
- {
954
- description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
955
- properties: {
956
- created_at: {
957
- description: 'Date and time at which Seam created the error.',
958
- format: 'date-time',
959
- type: 'string',
960
- },
961
- error_code: {
962
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
963
- enum: ['dormakaba_sites_disconnected'],
964
- type: 'string',
965
- },
966
- is_bridge_error: {
967
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
968
- type: 'boolean',
969
- },
970
- is_connected_account_error: {
971
- description: 'Indicates whether the error is related specifically to the connected account.',
972
- type: 'boolean',
973
- },
974
- message: {
975
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
976
- type: 'string',
977
- },
978
- },
979
- required: ['created_at', 'message', 'error_code'],
980
- type: 'object',
981
- 'x-resource-type': 'connected_account',
982
- },
983
994
  ],
984
995
  },
985
996
  type: 'array',
@@ -11702,6 +11713,45 @@ const openapi = {
11702
11713
  'x-resource-type': 'connected_account',
11703
11714
  'x-variant-group-key': 'locks',
11704
11715
  },
11716
+ {
11717
+ description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
11718
+ properties: {
11719
+ created_at: {
11720
+ description: 'Date and time at which Seam created the error.',
11721
+ format: 'date-time',
11722
+ type: 'string',
11723
+ },
11724
+ error_code: {
11725
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11726
+ enum: ['dormakaba_sites_disconnected'],
11727
+ type: 'string',
11728
+ },
11729
+ is_connected_account_error: {
11730
+ description: 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
11731
+ enum: [true],
11732
+ type: 'boolean',
11733
+ },
11734
+ is_device_error: {
11735
+ description: 'Indicates that the error is not a device error.',
11736
+ enum: [false],
11737
+ type: 'boolean',
11738
+ },
11739
+ message: {
11740
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
11741
+ type: 'string',
11742
+ },
11743
+ },
11744
+ required: [
11745
+ 'message',
11746
+ 'is_device_error',
11747
+ 'created_at',
11748
+ 'error_code',
11749
+ 'is_connected_account_error',
11750
+ ],
11751
+ type: 'object',
11752
+ 'x-resource-type': 'connected_account',
11753
+ 'x-variant-group-key': 'locks',
11754
+ },
11705
11755
  {
11706
11756
  deprecated: true,
11707
11757
  description: 'Indicates that the device is offline.',
@@ -11966,6 +12016,7 @@ const openapi = {
11966
12016
  type: 'object',
11967
12017
  'x-deprecated': 'Use `hub_disconnected` instead.',
11968
12018
  'x-resource-type': 'device',
12019
+ 'x-variant-group-key': 'locks',
11969
12020
  },
11970
12021
  {
11971
12022
  description: 'Indicates that device credentials are missing.',
@@ -12097,6 +12148,7 @@ const openapi = {
12097
12148
  type: 'object',
12098
12149
  'x-deprecated': 'Use `hub_disconnected` instead.',
12099
12150
  'x-resource-type': 'device',
12151
+ 'x-variant-group-key': 'locks',
12100
12152
  },
12101
12153
  {
12102
12154
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
@@ -12128,36 +12180,6 @@ const openapi = {
12128
12180
  type: 'object',
12129
12181
  'x-resource-type': 'connected_account',
12130
12182
  },
12131
- {
12132
- description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
12133
- properties: {
12134
- created_at: {
12135
- description: 'Date and time at which Seam created the error.',
12136
- format: 'date-time',
12137
- type: 'string',
12138
- },
12139
- error_code: {
12140
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12141
- enum: ['dormakaba_sites_disconnected'],
12142
- type: 'string',
12143
- },
12144
- is_bridge_error: {
12145
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
12146
- type: 'boolean',
12147
- },
12148
- is_connected_account_error: {
12149
- description: 'Indicates whether the error is related specifically to the connected account.',
12150
- type: 'boolean',
12151
- },
12152
- message: {
12153
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12154
- type: 'string',
12155
- },
12156
- },
12157
- required: ['created_at', 'message', 'error_code'],
12158
- type: 'object',
12159
- 'x-resource-type': 'connected_account',
12160
- },
12161
12183
  ],
12162
12184
  },
12163
12185
  type: 'array',
@@ -14693,6 +14715,7 @@ const openapi = {
14693
14715
  required: ['message', 'created_at', 'warning_code'],
14694
14716
  type: 'object',
14695
14717
  'x-deprecated': 'Use `hub_disconnected` device error instead.',
14718
+ 'x-variant-group-key': 'locks',
14696
14719
  },
14697
14720
  {
14698
14721
  description: 'Indicates that a third-party integration has been detected.',
@@ -14738,7 +14761,7 @@ const openapi = {
14738
14761
  'x-variant-group-key': 'locks',
14739
14762
  },
14740
14763
  {
14741
- description: '\n Indicates that the gateway signal is weak.\n ',
14764
+ description: 'Indicates that the gateway signal is weak.',
14742
14765
  properties: {
14743
14766
  created_at: {
14744
14767
  description: 'Date and time at which Seam created the warning.',
@@ -14757,6 +14780,7 @@ const openapi = {
14757
14780
  },
14758
14781
  required: ['message', 'created_at', 'warning_code'],
14759
14782
  type: 'object',
14783
+ 'x-variant-group-key': 'locks',
14760
14784
  },
14761
14785
  {
14762
14786
  description: 'Indicates that the device is in power saving mode and may have limited functionality.',
@@ -14929,6 +14953,7 @@ const openapi = {
14929
14953
  },
14930
14954
  required: ['message', 'created_at', 'warning_code'],
14931
14955
  type: 'object',
14956
+ 'x-variant-group-key': 'locks',
14932
14957
  },
14933
14958
  {
14934
14959
  description: 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
@@ -14994,6 +15019,7 @@ const openapi = {
14994
15019
  },
14995
15020
  required: ['message', 'created_at', 'warning_code'],
14996
15021
  type: 'object',
15022
+ 'x-variant-group-key': 'locks',
14997
15023
  },
14998
15024
  {
14999
15025
  description: 'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.',
@@ -15015,6 +15041,7 @@ const openapi = {
15015
15041
  },
15016
15042
  required: ['message', 'created_at', 'warning_code'],
15017
15043
  type: 'object',
15044
+ 'x-variant-group-key': 'locks',
15018
15045
  },
15019
15046
  {
15020
15047
  description: 'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.',
@@ -15036,6 +15063,7 @@ const openapi = {
15036
15063
  },
15037
15064
  required: ['message', 'created_at', 'warning_code'],
15038
15065
  type: 'object',
15066
+ 'x-variant-group-key': 'locks',
15039
15067
  },
15040
15068
  {
15041
15069
  description: 'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',
@@ -26354,6 +26382,45 @@ const openapi = {
26354
26382
  'x-resource-type': 'connected_account',
26355
26383
  'x-variant-group-key': 'locks',
26356
26384
  },
26385
+ {
26386
+ description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
26387
+ properties: {
26388
+ created_at: {
26389
+ description: 'Date and time at which Seam created the error.',
26390
+ format: 'date-time',
26391
+ type: 'string',
26392
+ },
26393
+ error_code: {
26394
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
26395
+ enum: ['dormakaba_sites_disconnected'],
26396
+ type: 'string',
26397
+ },
26398
+ is_connected_account_error: {
26399
+ description: 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
26400
+ enum: [true],
26401
+ type: 'boolean',
26402
+ },
26403
+ is_device_error: {
26404
+ description: 'Indicates that the error is not a device error.',
26405
+ enum: [false],
26406
+ type: 'boolean',
26407
+ },
26408
+ message: {
26409
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
26410
+ type: 'string',
26411
+ },
26412
+ },
26413
+ required: [
26414
+ 'message',
26415
+ 'is_device_error',
26416
+ 'created_at',
26417
+ 'error_code',
26418
+ 'is_connected_account_error',
26419
+ ],
26420
+ type: 'object',
26421
+ 'x-resource-type': 'connected_account',
26422
+ 'x-variant-group-key': 'locks',
26423
+ },
26357
26424
  {
26358
26425
  deprecated: true,
26359
26426
  description: 'Indicates that the device is offline.',
@@ -26618,6 +26685,7 @@ const openapi = {
26618
26685
  type: 'object',
26619
26686
  'x-deprecated': 'Use `hub_disconnected` instead.',
26620
26687
  'x-resource-type': 'device',
26688
+ 'x-variant-group-key': 'locks',
26621
26689
  },
26622
26690
  {
26623
26691
  description: 'Indicates that device credentials are missing.',
@@ -26749,6 +26817,7 @@ const openapi = {
26749
26817
  type: 'object',
26750
26818
  'x-deprecated': 'Use `hub_disconnected` instead.',
26751
26819
  'x-resource-type': 'device',
26820
+ 'x-variant-group-key': 'locks',
26752
26821
  },
26753
26822
  {
26754
26823
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
@@ -26780,36 +26849,6 @@ const openapi = {
26780
26849
  type: 'object',
26781
26850
  'x-resource-type': 'connected_account',
26782
26851
  },
26783
- {
26784
- description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
26785
- properties: {
26786
- created_at: {
26787
- description: 'Date and time at which Seam created the error.',
26788
- format: 'date-time',
26789
- type: 'string',
26790
- },
26791
- error_code: {
26792
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
26793
- enum: ['dormakaba_sites_disconnected'],
26794
- type: 'string',
26795
- },
26796
- is_bridge_error: {
26797
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
26798
- type: 'boolean',
26799
- },
26800
- is_connected_account_error: {
26801
- description: 'Indicates whether the error is related specifically to the connected account.',
26802
- type: 'boolean',
26803
- },
26804
- message: {
26805
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
26806
- type: 'string',
26807
- },
26808
- },
26809
- required: ['created_at', 'message', 'error_code'],
26810
- type: 'object',
26811
- 'x-resource-type': 'connected_account',
26812
- },
26813
26852
  ],
26814
26853
  },
26815
26854
  type: 'array',
@@ -29111,6 +29150,45 @@ const openapi = {
29111
29150
  'x-resource-type': 'connected_account',
29112
29151
  'x-variant-group-key': 'locks',
29113
29152
  },
29153
+ {
29154
+ description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
29155
+ properties: {
29156
+ created_at: {
29157
+ description: 'Date and time at which Seam created the error.',
29158
+ format: 'date-time',
29159
+ type: 'string',
29160
+ },
29161
+ error_code: {
29162
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
29163
+ enum: ['dormakaba_sites_disconnected'],
29164
+ type: 'string',
29165
+ },
29166
+ is_connected_account_error: {
29167
+ description: 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
29168
+ enum: [true],
29169
+ type: 'boolean',
29170
+ },
29171
+ is_device_error: {
29172
+ description: 'Indicates that the error is not a device error.',
29173
+ enum: [false],
29174
+ type: 'boolean',
29175
+ },
29176
+ message: {
29177
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
29178
+ type: 'string',
29179
+ },
29180
+ },
29181
+ required: [
29182
+ 'message',
29183
+ 'is_device_error',
29184
+ 'created_at',
29185
+ 'error_code',
29186
+ 'is_connected_account_error',
29187
+ ],
29188
+ type: 'object',
29189
+ 'x-resource-type': 'connected_account',
29190
+ 'x-variant-group-key': 'locks',
29191
+ },
29114
29192
  {
29115
29193
  deprecated: true,
29116
29194
  description: 'Indicates that the device is offline.',
@@ -29375,6 +29453,7 @@ const openapi = {
29375
29453
  type: 'object',
29376
29454
  'x-deprecated': 'Use `hub_disconnected` instead.',
29377
29455
  'x-resource-type': 'device',
29456
+ 'x-variant-group-key': 'locks',
29378
29457
  },
29379
29458
  {
29380
29459
  description: 'Indicates that device credentials are missing.',
@@ -29506,6 +29585,7 @@ const openapi = {
29506
29585
  type: 'object',
29507
29586
  'x-deprecated': 'Use `hub_disconnected` instead.',
29508
29587
  'x-resource-type': 'device',
29588
+ 'x-variant-group-key': 'locks',
29509
29589
  },
29510
29590
  {
29511
29591
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
@@ -29537,36 +29617,6 @@ const openapi = {
29537
29617
  type: 'object',
29538
29618
  'x-resource-type': 'connected_account',
29539
29619
  },
29540
- {
29541
- description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
29542
- properties: {
29543
- created_at: {
29544
- description: 'Date and time at which Seam created the error.',
29545
- format: 'date-time',
29546
- type: 'string',
29547
- },
29548
- error_code: {
29549
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
29550
- enum: ['dormakaba_sites_disconnected'],
29551
- type: 'string',
29552
- },
29553
- is_bridge_error: {
29554
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
29555
- type: 'boolean',
29556
- },
29557
- is_connected_account_error: {
29558
- description: 'Indicates whether the error is related specifically to the connected account.',
29559
- type: 'boolean',
29560
- },
29561
- message: {
29562
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
29563
- type: 'string',
29564
- },
29565
- },
29566
- required: ['created_at', 'message', 'error_code'],
29567
- type: 'object',
29568
- 'x-resource-type': 'connected_account',
29569
- },
29570
29620
  ],
29571
29621
  },
29572
29622
  type: 'array',
@@ -29824,6 +29874,7 @@ const openapi = {
29824
29874
  required: ['message', 'created_at', 'warning_code'],
29825
29875
  type: 'object',
29826
29876
  'x-deprecated': 'Use `hub_disconnected` device error instead.',
29877
+ 'x-variant-group-key': 'locks',
29827
29878
  },
29828
29879
  {
29829
29880
  description: 'Indicates that a third-party integration has been detected.',
@@ -29869,7 +29920,7 @@ const openapi = {
29869
29920
  'x-variant-group-key': 'locks',
29870
29921
  },
29871
29922
  {
29872
- description: '\n Indicates that the gateway signal is weak.\n ',
29923
+ description: 'Indicates that the gateway signal is weak.',
29873
29924
  properties: {
29874
29925
  created_at: {
29875
29926
  description: 'Date and time at which Seam created the warning.',
@@ -29888,6 +29939,7 @@ const openapi = {
29888
29939
  },
29889
29940
  required: ['message', 'created_at', 'warning_code'],
29890
29941
  type: 'object',
29942
+ 'x-variant-group-key': 'locks',
29891
29943
  },
29892
29944
  {
29893
29945
  description: 'Indicates that the device is in power saving mode and may have limited functionality.',
@@ -30060,6 +30112,7 @@ const openapi = {
30060
30112
  },
30061
30113
  required: ['message', 'created_at', 'warning_code'],
30062
30114
  type: 'object',
30115
+ 'x-variant-group-key': 'locks',
30063
30116
  },
30064
30117
  {
30065
30118
  description: 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
@@ -30125,6 +30178,7 @@ const openapi = {
30125
30178
  },
30126
30179
  required: ['message', 'created_at', 'warning_code'],
30127
30180
  type: 'object',
30181
+ 'x-variant-group-key': 'locks',
30128
30182
  },
30129
30183
  {
30130
30184
  description: 'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.',
@@ -30146,6 +30200,7 @@ const openapi = {
30146
30200
  },
30147
30201
  required: ['message', 'created_at', 'warning_code'],
30148
30202
  type: 'object',
30203
+ 'x-variant-group-key': 'locks',
30149
30204
  },
30150
30205
  {
30151
30206
  description: 'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.',
@@ -30167,6 +30222,7 @@ const openapi = {
30167
30222
  },
30168
30223
  required: ['message', 'created_at', 'warning_code'],
30169
30224
  type: 'object',
30225
+ 'x-variant-group-key': 'locks',
30170
30226
  },
30171
30227
  {
30172
30228
  description: 'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',