@seamapi/types 1.565.0 → 1.567.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 +308 -779
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +643 -1002
- package/dist/index.cjs +308 -779
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +3 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +3 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +552 -118
- package/lib/seam/connect/models/batch.js +5 -6
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customer/customer-portal.d.ts +52 -2
- package/lib/seam/connect/models/customer/customer-portal.js +10 -2
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
- package/lib/seam/connect/openapi.d.ts +538 -939
- package/lib/seam/connect/openapi.js +301 -775
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +39 -5
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +3 -0
- package/src/lib/seam/connect/models/batch.ts +5 -6
- package/src/lib/seam/connect/models/customer/customer-portal.ts +12 -2
- package/src/lib/seam/connect/openapi.ts +303 -877
- package/src/lib/seam/connect/route-types.ts +103 -55
|
@@ -2672,6 +2672,11 @@ export default {
|
|
|
2672
2672
|
},
|
|
2673
2673
|
type: 'object',
|
|
2674
2674
|
},
|
|
2675
|
+
space_ids: {
|
|
2676
|
+
description: 'IDs of the spaces that the entrance is in.',
|
|
2677
|
+
items: { format: 'uuid', type: 'string' },
|
|
2678
|
+
type: 'array',
|
|
2679
|
+
},
|
|
2675
2680
|
visionline_metadata: {
|
|
2676
2681
|
description: 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
2677
2682
|
properties: {
|
|
@@ -2720,6 +2725,7 @@ export default {
|
|
|
2720
2725
|
required: [
|
|
2721
2726
|
'acs_system_id',
|
|
2722
2727
|
'acs_entrance_id',
|
|
2728
|
+
'space_ids',
|
|
2723
2729
|
'created_at',
|
|
2724
2730
|
'display_name',
|
|
2725
2731
|
'connected_account_id',
|
|
@@ -18031,6 +18037,11 @@ export default {
|
|
|
18031
18037
|
},
|
|
18032
18038
|
type: 'object',
|
|
18033
18039
|
},
|
|
18040
|
+
space_ids: {
|
|
18041
|
+
description: 'IDs of the spaces that the entrance is in.',
|
|
18042
|
+
items: { format: 'uuid', type: 'string' },
|
|
18043
|
+
type: 'array',
|
|
18044
|
+
},
|
|
18034
18045
|
visionline_metadata: {
|
|
18035
18046
|
description: 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
18036
18047
|
properties: {
|
|
@@ -18079,6 +18090,7 @@ export default {
|
|
|
18079
18090
|
required: [
|
|
18080
18091
|
'acs_system_id',
|
|
18081
18092
|
'acs_entrance_id',
|
|
18093
|
+
'space_ids',
|
|
18082
18094
|
'created_at',
|
|
18083
18095
|
'display_name',
|
|
18084
18096
|
'connected_account_id',
|
|
@@ -35331,6 +35343,11 @@ export default {
|
|
|
35331
35343
|
description: 'Whether to exclude this feature from the portal.',
|
|
35332
35344
|
type: 'boolean',
|
|
35333
35345
|
},
|
|
35346
|
+
excluded_providers: {
|
|
35347
|
+
description: 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
35348
|
+
items: { type: 'string' },
|
|
35349
|
+
type: 'array',
|
|
35350
|
+
},
|
|
35334
35351
|
},
|
|
35335
35352
|
type: 'object',
|
|
35336
35353
|
},
|
|
@@ -35372,59 +35389,96 @@ export default {
|
|
|
35372
35389
|
manage: {
|
|
35373
35390
|
oneOf: [
|
|
35374
35391
|
{
|
|
35375
|
-
|
|
35376
|
-
|
|
35377
|
-
|
|
35378
|
-
|
|
35379
|
-
|
|
35380
|
-
|
|
35381
|
-
|
|
35382
|
-
|
|
35383
|
-
|
|
35384
|
-
|
|
35385
|
-
|
|
35386
|
-
|
|
35387
|
-
|
|
35388
|
-
|
|
35389
|
-
|
|
35390
|
-
|
|
35391
|
-
|
|
35392
|
-
|
|
35393
|
-
|
|
35394
|
-
|
|
35395
|
-
|
|
35396
|
-
|
|
35397
|
-
|
|
35398
|
-
|
|
35399
|
-
|
|
35400
|
-
|
|
35401
|
-
|
|
35402
|
-
|
|
35403
|
-
|
|
35404
|
-
|
|
35405
|
-
|
|
35406
|
-
|
|
35407
|
-
|
|
35408
|
-
|
|
35409
|
-
|
|
35410
|
-
|
|
35411
|
-
|
|
35412
|
-
|
|
35413
|
-
|
|
35414
|
-
|
|
35415
|
-
|
|
35416
|
-
|
|
35417
|
-
|
|
35418
|
-
|
|
35419
|
-
|
|
35420
|
-
|
|
35392
|
+
oneOf: [
|
|
35393
|
+
{
|
|
35394
|
+
properties: {
|
|
35395
|
+
space_key: { type: 'string' },
|
|
35396
|
+
},
|
|
35397
|
+
required: ['space_key'],
|
|
35398
|
+
type: 'object',
|
|
35399
|
+
},
|
|
35400
|
+
{
|
|
35401
|
+
properties: {
|
|
35402
|
+
property_key: { type: 'string' },
|
|
35403
|
+
},
|
|
35404
|
+
required: ['property_key'],
|
|
35405
|
+
type: 'object',
|
|
35406
|
+
},
|
|
35407
|
+
{
|
|
35408
|
+
properties: {
|
|
35409
|
+
room_key: { type: 'string' },
|
|
35410
|
+
},
|
|
35411
|
+
required: ['room_key'],
|
|
35412
|
+
type: 'object',
|
|
35413
|
+
},
|
|
35414
|
+
{
|
|
35415
|
+
properties: {
|
|
35416
|
+
common_area_key: { type: 'string' },
|
|
35417
|
+
},
|
|
35418
|
+
required: ['common_area_key'],
|
|
35419
|
+
type: 'object',
|
|
35420
|
+
},
|
|
35421
|
+
{
|
|
35422
|
+
properties: {
|
|
35423
|
+
unit_key: { type: 'string' },
|
|
35424
|
+
},
|
|
35425
|
+
required: ['unit_key'],
|
|
35426
|
+
type: 'object',
|
|
35427
|
+
},
|
|
35428
|
+
{
|
|
35429
|
+
properties: {
|
|
35430
|
+
facility_key: { type: 'string' },
|
|
35431
|
+
},
|
|
35432
|
+
required: ['facility_key'],
|
|
35433
|
+
type: 'object',
|
|
35434
|
+
},
|
|
35435
|
+
{
|
|
35436
|
+
properties: {
|
|
35437
|
+
building_key: { type: 'string' },
|
|
35438
|
+
},
|
|
35439
|
+
required: ['building_key'],
|
|
35440
|
+
type: 'object',
|
|
35441
|
+
},
|
|
35442
|
+
{
|
|
35443
|
+
properties: {
|
|
35444
|
+
listing_key: { type: 'string' },
|
|
35445
|
+
},
|
|
35446
|
+
required: ['listing_key'],
|
|
35447
|
+
type: 'object',
|
|
35448
|
+
},
|
|
35449
|
+
{
|
|
35450
|
+
properties: {
|
|
35451
|
+
property_listing_key: { type: 'string' },
|
|
35452
|
+
},
|
|
35453
|
+
required: ['property_listing_key'],
|
|
35454
|
+
type: 'object',
|
|
35455
|
+
},
|
|
35456
|
+
],
|
|
35421
35457
|
},
|
|
35422
35458
|
{
|
|
35423
|
-
|
|
35424
|
-
|
|
35425
|
-
|
|
35426
|
-
|
|
35427
|
-
|
|
35459
|
+
oneOf: [
|
|
35460
|
+
{
|
|
35461
|
+
properties: {
|
|
35462
|
+
reservation_key: { type: 'string' },
|
|
35463
|
+
},
|
|
35464
|
+
required: ['reservation_key'],
|
|
35465
|
+
type: 'object',
|
|
35466
|
+
},
|
|
35467
|
+
{
|
|
35468
|
+
properties: {
|
|
35469
|
+
booking_key: { type: 'string' },
|
|
35470
|
+
},
|
|
35471
|
+
required: ['booking_key'],
|
|
35472
|
+
type: 'object',
|
|
35473
|
+
},
|
|
35474
|
+
{
|
|
35475
|
+
properties: {
|
|
35476
|
+
access_grant_key: { type: 'string' },
|
|
35477
|
+
},
|
|
35478
|
+
required: ['access_grant_key'],
|
|
35479
|
+
type: 'object',
|
|
35480
|
+
},
|
|
35481
|
+
],
|
|
35428
35482
|
},
|
|
35429
35483
|
],
|
|
35430
35484
|
},
|
|
@@ -45777,7 +45831,13 @@ export default {
|
|
|
45777
45831
|
type: 'object',
|
|
45778
45832
|
},
|
|
45779
45833
|
connect: {
|
|
45780
|
-
properties: {
|
|
45834
|
+
properties: {
|
|
45835
|
+
exclude: { type: 'boolean' },
|
|
45836
|
+
excluded_providers: {
|
|
45837
|
+
items: { type: 'string' },
|
|
45838
|
+
type: 'array',
|
|
45839
|
+
},
|
|
45840
|
+
},
|
|
45781
45841
|
type: 'object',
|
|
45782
45842
|
},
|
|
45783
45843
|
manage_devices: {
|
|
@@ -45797,61 +45857,98 @@ export default {
|
|
|
45797
45857
|
manage: {
|
|
45798
45858
|
oneOf: [
|
|
45799
45859
|
{
|
|
45800
|
-
|
|
45801
|
-
|
|
45802
|
-
|
|
45803
|
-
|
|
45804
|
-
|
|
45805
|
-
|
|
45806
|
-
|
|
45807
|
-
|
|
45808
|
-
|
|
45809
|
-
|
|
45810
|
-
|
|
45811
|
-
|
|
45812
|
-
|
|
45813
|
-
|
|
45814
|
-
|
|
45815
|
-
|
|
45816
|
-
|
|
45817
|
-
|
|
45818
|
-
|
|
45819
|
-
|
|
45820
|
-
|
|
45821
|
-
|
|
45822
|
-
|
|
45823
|
-
|
|
45824
|
-
|
|
45825
|
-
|
|
45826
|
-
|
|
45827
|
-
|
|
45828
|
-
|
|
45829
|
-
|
|
45830
|
-
|
|
45831
|
-
|
|
45832
|
-
|
|
45833
|
-
|
|
45834
|
-
|
|
45835
|
-
|
|
45836
|
-
|
|
45837
|
-
|
|
45838
|
-
|
|
45839
|
-
|
|
45840
|
-
|
|
45841
|
-
|
|
45842
|
-
|
|
45843
|
-
|
|
45844
|
-
|
|
45845
|
-
|
|
45846
|
-
|
|
45847
|
-
|
|
45860
|
+
oneOf: [
|
|
45861
|
+
{
|
|
45862
|
+
properties: {
|
|
45863
|
+
space_key: { type: 'string' },
|
|
45864
|
+
},
|
|
45865
|
+
required: ['space_key'],
|
|
45866
|
+
type: 'object',
|
|
45867
|
+
},
|
|
45868
|
+
{
|
|
45869
|
+
properties: {
|
|
45870
|
+
property_key: { type: 'string' },
|
|
45871
|
+
},
|
|
45872
|
+
required: ['property_key'],
|
|
45873
|
+
type: 'object',
|
|
45874
|
+
},
|
|
45875
|
+
{
|
|
45876
|
+
properties: {
|
|
45877
|
+
room_key: { type: 'string' },
|
|
45878
|
+
},
|
|
45879
|
+
required: ['room_key'],
|
|
45880
|
+
type: 'object',
|
|
45881
|
+
},
|
|
45882
|
+
{
|
|
45883
|
+
properties: {
|
|
45884
|
+
common_area_key: { type: 'string' },
|
|
45885
|
+
},
|
|
45886
|
+
required: ['common_area_key'],
|
|
45887
|
+
type: 'object',
|
|
45888
|
+
},
|
|
45889
|
+
{
|
|
45890
|
+
properties: {
|
|
45891
|
+
unit_key: { type: 'string' },
|
|
45892
|
+
},
|
|
45893
|
+
required: ['unit_key'],
|
|
45894
|
+
type: 'object',
|
|
45895
|
+
},
|
|
45896
|
+
{
|
|
45897
|
+
properties: {
|
|
45898
|
+
facility_key: { type: 'string' },
|
|
45899
|
+
},
|
|
45900
|
+
required: ['facility_key'],
|
|
45901
|
+
type: 'object',
|
|
45902
|
+
},
|
|
45903
|
+
{
|
|
45904
|
+
properties: {
|
|
45905
|
+
building_key: { type: 'string' },
|
|
45906
|
+
},
|
|
45907
|
+
required: ['building_key'],
|
|
45908
|
+
type: 'object',
|
|
45909
|
+
},
|
|
45910
|
+
{
|
|
45911
|
+
properties: {
|
|
45912
|
+
listing_key: { type: 'string' },
|
|
45913
|
+
},
|
|
45914
|
+
required: ['listing_key'],
|
|
45915
|
+
type: 'object',
|
|
45916
|
+
},
|
|
45917
|
+
{
|
|
45918
|
+
properties: {
|
|
45919
|
+
property_listing_key: {
|
|
45920
|
+
type: 'string',
|
|
45921
|
+
},
|
|
45922
|
+
},
|
|
45923
|
+
required: ['property_listing_key'],
|
|
45924
|
+
type: 'object',
|
|
45925
|
+
},
|
|
45926
|
+
],
|
|
45848
45927
|
},
|
|
45849
45928
|
{
|
|
45850
|
-
|
|
45851
|
-
|
|
45852
|
-
|
|
45853
|
-
|
|
45854
|
-
|
|
45929
|
+
oneOf: [
|
|
45930
|
+
{
|
|
45931
|
+
properties: {
|
|
45932
|
+
reservation_key: { type: 'string' },
|
|
45933
|
+
},
|
|
45934
|
+
required: ['reservation_key'],
|
|
45935
|
+
type: 'object',
|
|
45936
|
+
},
|
|
45937
|
+
{
|
|
45938
|
+
properties: {
|
|
45939
|
+
booking_key: { type: 'string' },
|
|
45940
|
+
},
|
|
45941
|
+
required: ['booking_key'],
|
|
45942
|
+
type: 'object',
|
|
45943
|
+
},
|
|
45944
|
+
{
|
|
45945
|
+
properties: {
|
|
45946
|
+
access_grant_key: { type: 'string' },
|
|
45947
|
+
},
|
|
45948
|
+
required: ['access_grant_key'],
|
|
45949
|
+
type: 'object',
|
|
45950
|
+
},
|
|
45951
|
+
],
|
|
45855
45952
|
},
|
|
45856
45953
|
],
|
|
45857
45954
|
},
|
|
@@ -45937,7 +46034,13 @@ export default {
|
|
|
45937
46034
|
type: 'object',
|
|
45938
46035
|
},
|
|
45939
46036
|
connect: {
|
|
45940
|
-
properties: {
|
|
46037
|
+
properties: {
|
|
46038
|
+
exclude: { type: 'boolean' },
|
|
46039
|
+
excluded_providers: {
|
|
46040
|
+
items: { type: 'string' },
|
|
46041
|
+
type: 'array',
|
|
46042
|
+
},
|
|
46043
|
+
},
|
|
45941
46044
|
type: 'object',
|
|
45942
46045
|
},
|
|
45943
46046
|
manage_devices: {
|
|
@@ -45957,61 +46060,98 @@ export default {
|
|
|
45957
46060
|
manage: {
|
|
45958
46061
|
oneOf: [
|
|
45959
46062
|
{
|
|
45960
|
-
|
|
45961
|
-
|
|
45962
|
-
|
|
45963
|
-
|
|
45964
|
-
|
|
45965
|
-
|
|
45966
|
-
|
|
45967
|
-
|
|
45968
|
-
|
|
45969
|
-
|
|
45970
|
-
|
|
45971
|
-
|
|
45972
|
-
|
|
45973
|
-
|
|
45974
|
-
|
|
45975
|
-
|
|
45976
|
-
|
|
45977
|
-
|
|
45978
|
-
|
|
45979
|
-
|
|
45980
|
-
|
|
45981
|
-
|
|
45982
|
-
|
|
45983
|
-
|
|
45984
|
-
|
|
45985
|
-
|
|
45986
|
-
|
|
45987
|
-
|
|
45988
|
-
|
|
45989
|
-
|
|
45990
|
-
|
|
45991
|
-
|
|
45992
|
-
|
|
45993
|
-
|
|
45994
|
-
|
|
45995
|
-
|
|
45996
|
-
|
|
45997
|
-
|
|
45998
|
-
|
|
45999
|
-
|
|
46000
|
-
|
|
46001
|
-
|
|
46002
|
-
|
|
46003
|
-
|
|
46004
|
-
|
|
46005
|
-
|
|
46006
|
-
|
|
46007
|
-
|
|
46063
|
+
oneOf: [
|
|
46064
|
+
{
|
|
46065
|
+
properties: {
|
|
46066
|
+
space_key: { type: 'string' },
|
|
46067
|
+
},
|
|
46068
|
+
required: ['space_key'],
|
|
46069
|
+
type: 'object',
|
|
46070
|
+
},
|
|
46071
|
+
{
|
|
46072
|
+
properties: {
|
|
46073
|
+
property_key: { type: 'string' },
|
|
46074
|
+
},
|
|
46075
|
+
required: ['property_key'],
|
|
46076
|
+
type: 'object',
|
|
46077
|
+
},
|
|
46078
|
+
{
|
|
46079
|
+
properties: {
|
|
46080
|
+
room_key: { type: 'string' },
|
|
46081
|
+
},
|
|
46082
|
+
required: ['room_key'],
|
|
46083
|
+
type: 'object',
|
|
46084
|
+
},
|
|
46085
|
+
{
|
|
46086
|
+
properties: {
|
|
46087
|
+
common_area_key: { type: 'string' },
|
|
46088
|
+
},
|
|
46089
|
+
required: ['common_area_key'],
|
|
46090
|
+
type: 'object',
|
|
46091
|
+
},
|
|
46092
|
+
{
|
|
46093
|
+
properties: {
|
|
46094
|
+
unit_key: { type: 'string' },
|
|
46095
|
+
},
|
|
46096
|
+
required: ['unit_key'],
|
|
46097
|
+
type: 'object',
|
|
46098
|
+
},
|
|
46099
|
+
{
|
|
46100
|
+
properties: {
|
|
46101
|
+
facility_key: { type: 'string' },
|
|
46102
|
+
},
|
|
46103
|
+
required: ['facility_key'],
|
|
46104
|
+
type: 'object',
|
|
46105
|
+
},
|
|
46106
|
+
{
|
|
46107
|
+
properties: {
|
|
46108
|
+
building_key: { type: 'string' },
|
|
46109
|
+
},
|
|
46110
|
+
required: ['building_key'],
|
|
46111
|
+
type: 'object',
|
|
46112
|
+
},
|
|
46113
|
+
{
|
|
46114
|
+
properties: {
|
|
46115
|
+
listing_key: { type: 'string' },
|
|
46116
|
+
},
|
|
46117
|
+
required: ['listing_key'],
|
|
46118
|
+
type: 'object',
|
|
46119
|
+
},
|
|
46120
|
+
{
|
|
46121
|
+
properties: {
|
|
46122
|
+
property_listing_key: {
|
|
46123
|
+
type: 'string',
|
|
46124
|
+
},
|
|
46125
|
+
},
|
|
46126
|
+
required: ['property_listing_key'],
|
|
46127
|
+
type: 'object',
|
|
46128
|
+
},
|
|
46129
|
+
],
|
|
46008
46130
|
},
|
|
46009
46131
|
{
|
|
46010
|
-
|
|
46011
|
-
|
|
46012
|
-
|
|
46013
|
-
|
|
46014
|
-
|
|
46132
|
+
oneOf: [
|
|
46133
|
+
{
|
|
46134
|
+
properties: {
|
|
46135
|
+
reservation_key: { type: 'string' },
|
|
46136
|
+
},
|
|
46137
|
+
required: ['reservation_key'],
|
|
46138
|
+
type: 'object',
|
|
46139
|
+
},
|
|
46140
|
+
{
|
|
46141
|
+
properties: {
|
|
46142
|
+
booking_key: { type: 'string' },
|
|
46143
|
+
},
|
|
46144
|
+
required: ['booking_key'],
|
|
46145
|
+
type: 'object',
|
|
46146
|
+
},
|
|
46147
|
+
{
|
|
46148
|
+
properties: {
|
|
46149
|
+
access_grant_key: { type: 'string' },
|
|
46150
|
+
},
|
|
46151
|
+
required: ['access_grant_key'],
|
|
46152
|
+
type: 'object',
|
|
46153
|
+
},
|
|
46154
|
+
],
|
|
46015
46155
|
},
|
|
46016
46156
|
],
|
|
46017
46157
|
},
|
|
@@ -47971,314 +48111,7 @@ export default {
|
|
|
47971
48111
|
description: 'ID of the affected access system user.',
|
|
47972
48112
|
properties: {
|
|
47973
48113
|
acs_entrances: {
|
|
47974
|
-
items: {
|
|
47975
|
-
description: 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.',
|
|
47976
|
-
properties: {
|
|
47977
|
-
acs_entrance_id: {
|
|
47978
|
-
description: 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
47979
|
-
format: 'uuid',
|
|
47980
|
-
type: 'string',
|
|
47981
|
-
},
|
|
47982
|
-
acs_system_id: {
|
|
47983
|
-
description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
47984
|
-
format: 'uuid',
|
|
47985
|
-
type: 'string',
|
|
47986
|
-
},
|
|
47987
|
-
assa_abloy_vostio_metadata: {
|
|
47988
|
-
description: 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
47989
|
-
properties: {
|
|
47990
|
-
door_name: {
|
|
47991
|
-
description: 'Name of the door in the Vostio access system.',
|
|
47992
|
-
type: 'string',
|
|
47993
|
-
},
|
|
47994
|
-
door_number: {
|
|
47995
|
-
description: 'Number of the door in the Vostio access system.',
|
|
47996
|
-
format: 'float',
|
|
47997
|
-
type: 'number',
|
|
47998
|
-
},
|
|
47999
|
-
door_type: {
|
|
48000
|
-
description: 'Type of the door in the Vostio access system.',
|
|
48001
|
-
enum: [
|
|
48002
|
-
'CommonDoor',
|
|
48003
|
-
'EntranceDoor',
|
|
48004
|
-
'GuestDoor',
|
|
48005
|
-
'Elevator',
|
|
48006
|
-
],
|
|
48007
|
-
type: 'string',
|
|
48008
|
-
},
|
|
48009
|
-
pms_id: {
|
|
48010
|
-
description: 'PMS ID of the door in the Vostio access system.',
|
|
48011
|
-
type: 'string',
|
|
48012
|
-
},
|
|
48013
|
-
stand_open: {
|
|
48014
|
-
description: 'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.',
|
|
48015
|
-
type: 'boolean',
|
|
48016
|
-
},
|
|
48017
|
-
},
|
|
48018
|
-
required: ['door_type', 'door_name'],
|
|
48019
|
-
type: 'object',
|
|
48020
|
-
},
|
|
48021
|
-
can_unlock_with_card: {
|
|
48022
|
-
description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
48023
|
-
type: 'boolean',
|
|
48024
|
-
},
|
|
48025
|
-
can_unlock_with_code: {
|
|
48026
|
-
description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
48027
|
-
type: 'boolean',
|
|
48028
|
-
},
|
|
48029
|
-
can_unlock_with_mobile_key: {
|
|
48030
|
-
description: 'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
|
|
48031
|
-
type: 'boolean',
|
|
48032
|
-
},
|
|
48033
|
-
connected_account_id: {
|
|
48034
|
-
description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48035
|
-
format: 'uuid',
|
|
48036
|
-
type: 'string',
|
|
48037
|
-
},
|
|
48038
|
-
created_at: {
|
|
48039
|
-
description: 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
48040
|
-
format: 'date-time',
|
|
48041
|
-
type: 'string',
|
|
48042
|
-
},
|
|
48043
|
-
display_name: {
|
|
48044
|
-
description: 'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48045
|
-
type: 'string',
|
|
48046
|
-
},
|
|
48047
|
-
dormakaba_ambiance_metadata: {
|
|
48048
|
-
description: 'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48049
|
-
properties: {
|
|
48050
|
-
access_point_name: {
|
|
48051
|
-
description: 'Name of the access point in the dormakaba Ambiance access system.',
|
|
48052
|
-
type: 'string',
|
|
48053
|
-
},
|
|
48054
|
-
},
|
|
48055
|
-
required: ['access_point_name'],
|
|
48056
|
-
type: 'object',
|
|
48057
|
-
},
|
|
48058
|
-
dormakaba_community_metadata: {
|
|
48059
|
-
description: 'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48060
|
-
properties: {
|
|
48061
|
-
access_point_name: {
|
|
48062
|
-
description: 'Name of the access point in the dormakaba Community access system.',
|
|
48063
|
-
type: 'string',
|
|
48064
|
-
},
|
|
48065
|
-
access_point_profile: {
|
|
48066
|
-
description: 'Type of access point profile in the dormakaba Community access system.',
|
|
48067
|
-
type: 'string',
|
|
48068
|
-
},
|
|
48069
|
-
},
|
|
48070
|
-
required: [
|
|
48071
|
-
'access_point_name',
|
|
48072
|
-
'access_point_profile',
|
|
48073
|
-
],
|
|
48074
|
-
type: 'object',
|
|
48075
|
-
},
|
|
48076
|
-
errors: {
|
|
48077
|
-
description: 'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48078
|
-
items: {
|
|
48079
|
-
properties: {
|
|
48080
|
-
error_code: {
|
|
48081
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
48082
|
-
type: 'string',
|
|
48083
|
-
},
|
|
48084
|
-
message: {
|
|
48085
|
-
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
48086
|
-
type: 'string',
|
|
48087
|
-
},
|
|
48088
|
-
},
|
|
48089
|
-
required: ['error_code', 'message'],
|
|
48090
|
-
type: 'object',
|
|
48091
|
-
},
|
|
48092
|
-
type: 'array',
|
|
48093
|
-
},
|
|
48094
|
-
hotek_metadata: {
|
|
48095
|
-
description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48096
|
-
properties: {
|
|
48097
|
-
display_name: {
|
|
48098
|
-
description: 'Display name of the entrance.',
|
|
48099
|
-
type: 'string',
|
|
48100
|
-
},
|
|
48101
|
-
door_type: {
|
|
48102
|
-
description: 'Type of door.',
|
|
48103
|
-
enum: ['common_area', 'guest'],
|
|
48104
|
-
type: 'string',
|
|
48105
|
-
},
|
|
48106
|
-
room_number: {
|
|
48107
|
-
description: 'Room number of the entrance.',
|
|
48108
|
-
type: 'string',
|
|
48109
|
-
},
|
|
48110
|
-
},
|
|
48111
|
-
required: [
|
|
48112
|
-
'room_number',
|
|
48113
|
-
'display_name',
|
|
48114
|
-
'door_type',
|
|
48115
|
-
],
|
|
48116
|
-
type: 'object',
|
|
48117
|
-
},
|
|
48118
|
-
latch_metadata: {
|
|
48119
|
-
description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48120
|
-
properties: {
|
|
48121
|
-
accessibility_type: {
|
|
48122
|
-
description: 'Accessibility type in the Latch access system.',
|
|
48123
|
-
type: 'string',
|
|
48124
|
-
},
|
|
48125
|
-
door_name: {
|
|
48126
|
-
description: 'Name of the door in the Latch access system.',
|
|
48127
|
-
type: 'string',
|
|
48128
|
-
},
|
|
48129
|
-
door_type: {
|
|
48130
|
-
description: 'Type of the door in the Latch access system.',
|
|
48131
|
-
type: 'string',
|
|
48132
|
-
},
|
|
48133
|
-
is_connected: {
|
|
48134
|
-
description: 'Indicates whether the entrance is connected.',
|
|
48135
|
-
type: 'boolean',
|
|
48136
|
-
},
|
|
48137
|
-
},
|
|
48138
|
-
required: [
|
|
48139
|
-
'accessibility_type',
|
|
48140
|
-
'door_name',
|
|
48141
|
-
'door_type',
|
|
48142
|
-
'is_connected',
|
|
48143
|
-
],
|
|
48144
|
-
type: 'object',
|
|
48145
|
-
},
|
|
48146
|
-
salto_ks_metadata: {
|
|
48147
|
-
description: 'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48148
|
-
properties: {
|
|
48149
|
-
battery_level: {
|
|
48150
|
-
description: 'Battery level of the door access device.',
|
|
48151
|
-
type: 'string',
|
|
48152
|
-
},
|
|
48153
|
-
door_name: {
|
|
48154
|
-
description: 'Name of the door in the Salto KS access system.',
|
|
48155
|
-
type: 'string',
|
|
48156
|
-
},
|
|
48157
|
-
intrusion_alarm: {
|
|
48158
|
-
description: 'Indicates whether an intrusion alarm is active on the door.',
|
|
48159
|
-
type: 'boolean',
|
|
48160
|
-
},
|
|
48161
|
-
left_open_alarm: {
|
|
48162
|
-
description: 'Indicates whether the door is left open.',
|
|
48163
|
-
type: 'boolean',
|
|
48164
|
-
},
|
|
48165
|
-
lock_type: {
|
|
48166
|
-
description: 'Type of the lock in the Salto KS access system.',
|
|
48167
|
-
type: 'string',
|
|
48168
|
-
},
|
|
48169
|
-
locked_state: {
|
|
48170
|
-
description: 'Locked state of the door in the Salto KS access system.',
|
|
48171
|
-
type: 'string',
|
|
48172
|
-
},
|
|
48173
|
-
online: {
|
|
48174
|
-
description: 'Indicates whether the door access device is online.',
|
|
48175
|
-
type: 'boolean',
|
|
48176
|
-
},
|
|
48177
|
-
privacy_mode: {
|
|
48178
|
-
description: 'Indicates whether privacy mode is enabled for the lock.',
|
|
48179
|
-
type: 'boolean',
|
|
48180
|
-
},
|
|
48181
|
-
},
|
|
48182
|
-
required: [
|
|
48183
|
-
'door_name',
|
|
48184
|
-
'locked_state',
|
|
48185
|
-
'lock_type',
|
|
48186
|
-
'battery_level',
|
|
48187
|
-
],
|
|
48188
|
-
type: 'object',
|
|
48189
|
-
},
|
|
48190
|
-
salto_space_metadata: {
|
|
48191
|
-
description: 'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48192
|
-
properties: {
|
|
48193
|
-
door_description: {
|
|
48194
|
-
description: 'Description of the door in the Salto Space access system.',
|
|
48195
|
-
type: 'string',
|
|
48196
|
-
},
|
|
48197
|
-
door_id: {
|
|
48198
|
-
description: 'Door ID in the Salto Space access system.',
|
|
48199
|
-
type: 'string',
|
|
48200
|
-
},
|
|
48201
|
-
door_name: {
|
|
48202
|
-
description: 'Name of the door in the Salto Space access system.',
|
|
48203
|
-
type: 'string',
|
|
48204
|
-
},
|
|
48205
|
-
ext_door_id: {
|
|
48206
|
-
deprecated: true,
|
|
48207
|
-
type: 'string',
|
|
48208
|
-
'x-deprecated': 'use door_id.',
|
|
48209
|
-
},
|
|
48210
|
-
room_description: {
|
|
48211
|
-
description: 'Description of the room in the Salto Space access system.',
|
|
48212
|
-
type: 'string',
|
|
48213
|
-
},
|
|
48214
|
-
room_name: {
|
|
48215
|
-
description: 'Name of the room in the Salto Space access system.',
|
|
48216
|
-
type: 'string',
|
|
48217
|
-
},
|
|
48218
|
-
},
|
|
48219
|
-
type: 'object',
|
|
48220
|
-
},
|
|
48221
|
-
space_ids: {
|
|
48222
|
-
items: { format: 'uuid', type: 'string' },
|
|
48223
|
-
type: 'array',
|
|
48224
|
-
},
|
|
48225
|
-
visionline_metadata: {
|
|
48226
|
-
description: 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
48227
|
-
properties: {
|
|
48228
|
-
door_category: {
|
|
48229
|
-
description: 'Category of the door in the Visionline access system.',
|
|
48230
|
-
enum: [
|
|
48231
|
-
'entrance',
|
|
48232
|
-
'guest',
|
|
48233
|
-
'elevator reader',
|
|
48234
|
-
'common',
|
|
48235
|
-
'common (PMS)',
|
|
48236
|
-
],
|
|
48237
|
-
type: 'string',
|
|
48238
|
-
},
|
|
48239
|
-
door_name: {
|
|
48240
|
-
description: 'Name of the door in the Visionline access system.',
|
|
48241
|
-
type: 'string',
|
|
48242
|
-
},
|
|
48243
|
-
profiles: {
|
|
48244
|
-
description: 'Profile for the door in the Visionline access system.',
|
|
48245
|
-
items: {
|
|
48246
|
-
properties: {
|
|
48247
|
-
visionline_door_profile_id: {
|
|
48248
|
-
description: 'Door profile ID in the Visionline access system.',
|
|
48249
|
-
type: 'string',
|
|
48250
|
-
},
|
|
48251
|
-
visionline_door_profile_type: {
|
|
48252
|
-
description: 'Door profile type in the Visionline access system.',
|
|
48253
|
-
enum: ['BLE', 'commonDoor', 'touch'],
|
|
48254
|
-
type: 'string',
|
|
48255
|
-
},
|
|
48256
|
-
},
|
|
48257
|
-
required: [
|
|
48258
|
-
'visionline_door_profile_id',
|
|
48259
|
-
'visionline_door_profile_type',
|
|
48260
|
-
],
|
|
48261
|
-
type: 'object',
|
|
48262
|
-
},
|
|
48263
|
-
type: 'array',
|
|
48264
|
-
},
|
|
48265
|
-
},
|
|
48266
|
-
required: ['door_name', 'door_category'],
|
|
48267
|
-
type: 'object',
|
|
48268
|
-
},
|
|
48269
|
-
},
|
|
48270
|
-
required: [
|
|
48271
|
-
'acs_system_id',
|
|
48272
|
-
'acs_entrance_id',
|
|
48273
|
-
'created_at',
|
|
48274
|
-
'display_name',
|
|
48275
|
-
'connected_account_id',
|
|
48276
|
-
'errors',
|
|
48277
|
-
'space_ids',
|
|
48278
|
-
],
|
|
48279
|
-
type: 'object',
|
|
48280
|
-
'x-route-path': '/acs/entrances',
|
|
48281
|
-
},
|
|
48114
|
+
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
48282
48115
|
type: 'array',
|
|
48283
48116
|
},
|
|
48284
48117
|
acs_systems: {
|
|
@@ -51900,314 +51733,7 @@ export default {
|
|
|
51900
51733
|
description: 'ID of the affected access system user.',
|
|
51901
51734
|
properties: {
|
|
51902
51735
|
acs_entrances: {
|
|
51903
|
-
items: {
|
|
51904
|
-
description: 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.',
|
|
51905
|
-
properties: {
|
|
51906
|
-
acs_entrance_id: {
|
|
51907
|
-
description: 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51908
|
-
format: 'uuid',
|
|
51909
|
-
type: 'string',
|
|
51910
|
-
},
|
|
51911
|
-
acs_system_id: {
|
|
51912
|
-
description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51913
|
-
format: 'uuid',
|
|
51914
|
-
type: 'string',
|
|
51915
|
-
},
|
|
51916
|
-
assa_abloy_vostio_metadata: {
|
|
51917
|
-
description: 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51918
|
-
properties: {
|
|
51919
|
-
door_name: {
|
|
51920
|
-
description: 'Name of the door in the Vostio access system.',
|
|
51921
|
-
type: 'string',
|
|
51922
|
-
},
|
|
51923
|
-
door_number: {
|
|
51924
|
-
description: 'Number of the door in the Vostio access system.',
|
|
51925
|
-
format: 'float',
|
|
51926
|
-
type: 'number',
|
|
51927
|
-
},
|
|
51928
|
-
door_type: {
|
|
51929
|
-
description: 'Type of the door in the Vostio access system.',
|
|
51930
|
-
enum: [
|
|
51931
|
-
'CommonDoor',
|
|
51932
|
-
'EntranceDoor',
|
|
51933
|
-
'GuestDoor',
|
|
51934
|
-
'Elevator',
|
|
51935
|
-
],
|
|
51936
|
-
type: 'string',
|
|
51937
|
-
},
|
|
51938
|
-
pms_id: {
|
|
51939
|
-
description: 'PMS ID of the door in the Vostio access system.',
|
|
51940
|
-
type: 'string',
|
|
51941
|
-
},
|
|
51942
|
-
stand_open: {
|
|
51943
|
-
description: 'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.',
|
|
51944
|
-
type: 'boolean',
|
|
51945
|
-
},
|
|
51946
|
-
},
|
|
51947
|
-
required: ['door_type', 'door_name'],
|
|
51948
|
-
type: 'object',
|
|
51949
|
-
},
|
|
51950
|
-
can_unlock_with_card: {
|
|
51951
|
-
description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
51952
|
-
type: 'boolean',
|
|
51953
|
-
},
|
|
51954
|
-
can_unlock_with_code: {
|
|
51955
|
-
description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
51956
|
-
type: 'boolean',
|
|
51957
|
-
},
|
|
51958
|
-
can_unlock_with_mobile_key: {
|
|
51959
|
-
description: 'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
|
|
51960
|
-
type: 'boolean',
|
|
51961
|
-
},
|
|
51962
|
-
connected_account_id: {
|
|
51963
|
-
description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51964
|
-
format: 'uuid',
|
|
51965
|
-
type: 'string',
|
|
51966
|
-
},
|
|
51967
|
-
created_at: {
|
|
51968
|
-
description: 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
51969
|
-
format: 'date-time',
|
|
51970
|
-
type: 'string',
|
|
51971
|
-
},
|
|
51972
|
-
display_name: {
|
|
51973
|
-
description: 'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51974
|
-
type: 'string',
|
|
51975
|
-
},
|
|
51976
|
-
dormakaba_ambiance_metadata: {
|
|
51977
|
-
description: 'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51978
|
-
properties: {
|
|
51979
|
-
access_point_name: {
|
|
51980
|
-
description: 'Name of the access point in the dormakaba Ambiance access system.',
|
|
51981
|
-
type: 'string',
|
|
51982
|
-
},
|
|
51983
|
-
},
|
|
51984
|
-
required: ['access_point_name'],
|
|
51985
|
-
type: 'object',
|
|
51986
|
-
},
|
|
51987
|
-
dormakaba_community_metadata: {
|
|
51988
|
-
description: 'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51989
|
-
properties: {
|
|
51990
|
-
access_point_name: {
|
|
51991
|
-
description: 'Name of the access point in the dormakaba Community access system.',
|
|
51992
|
-
type: 'string',
|
|
51993
|
-
},
|
|
51994
|
-
access_point_profile: {
|
|
51995
|
-
description: 'Type of access point profile in the dormakaba Community access system.',
|
|
51996
|
-
type: 'string',
|
|
51997
|
-
},
|
|
51998
|
-
},
|
|
51999
|
-
required: [
|
|
52000
|
-
'access_point_name',
|
|
52001
|
-
'access_point_profile',
|
|
52002
|
-
],
|
|
52003
|
-
type: 'object',
|
|
52004
|
-
},
|
|
52005
|
-
errors: {
|
|
52006
|
-
description: 'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52007
|
-
items: {
|
|
52008
|
-
properties: {
|
|
52009
|
-
error_code: {
|
|
52010
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
52011
|
-
type: 'string',
|
|
52012
|
-
},
|
|
52013
|
-
message: {
|
|
52014
|
-
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
52015
|
-
type: 'string',
|
|
52016
|
-
},
|
|
52017
|
-
},
|
|
52018
|
-
required: ['error_code', 'message'],
|
|
52019
|
-
type: 'object',
|
|
52020
|
-
},
|
|
52021
|
-
type: 'array',
|
|
52022
|
-
},
|
|
52023
|
-
hotek_metadata: {
|
|
52024
|
-
description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52025
|
-
properties: {
|
|
52026
|
-
display_name: {
|
|
52027
|
-
description: 'Display name of the entrance.',
|
|
52028
|
-
type: 'string',
|
|
52029
|
-
},
|
|
52030
|
-
door_type: {
|
|
52031
|
-
description: 'Type of door.',
|
|
52032
|
-
enum: ['common_area', 'guest'],
|
|
52033
|
-
type: 'string',
|
|
52034
|
-
},
|
|
52035
|
-
room_number: {
|
|
52036
|
-
description: 'Room number of the entrance.',
|
|
52037
|
-
type: 'string',
|
|
52038
|
-
},
|
|
52039
|
-
},
|
|
52040
|
-
required: [
|
|
52041
|
-
'room_number',
|
|
52042
|
-
'display_name',
|
|
52043
|
-
'door_type',
|
|
52044
|
-
],
|
|
52045
|
-
type: 'object',
|
|
52046
|
-
},
|
|
52047
|
-
latch_metadata: {
|
|
52048
|
-
description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52049
|
-
properties: {
|
|
52050
|
-
accessibility_type: {
|
|
52051
|
-
description: 'Accessibility type in the Latch access system.',
|
|
52052
|
-
type: 'string',
|
|
52053
|
-
},
|
|
52054
|
-
door_name: {
|
|
52055
|
-
description: 'Name of the door in the Latch access system.',
|
|
52056
|
-
type: 'string',
|
|
52057
|
-
},
|
|
52058
|
-
door_type: {
|
|
52059
|
-
description: 'Type of the door in the Latch access system.',
|
|
52060
|
-
type: 'string',
|
|
52061
|
-
},
|
|
52062
|
-
is_connected: {
|
|
52063
|
-
description: 'Indicates whether the entrance is connected.',
|
|
52064
|
-
type: 'boolean',
|
|
52065
|
-
},
|
|
52066
|
-
},
|
|
52067
|
-
required: [
|
|
52068
|
-
'accessibility_type',
|
|
52069
|
-
'door_name',
|
|
52070
|
-
'door_type',
|
|
52071
|
-
'is_connected',
|
|
52072
|
-
],
|
|
52073
|
-
type: 'object',
|
|
52074
|
-
},
|
|
52075
|
-
salto_ks_metadata: {
|
|
52076
|
-
description: 'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52077
|
-
properties: {
|
|
52078
|
-
battery_level: {
|
|
52079
|
-
description: 'Battery level of the door access device.',
|
|
52080
|
-
type: 'string',
|
|
52081
|
-
},
|
|
52082
|
-
door_name: {
|
|
52083
|
-
description: 'Name of the door in the Salto KS access system.',
|
|
52084
|
-
type: 'string',
|
|
52085
|
-
},
|
|
52086
|
-
intrusion_alarm: {
|
|
52087
|
-
description: 'Indicates whether an intrusion alarm is active on the door.',
|
|
52088
|
-
type: 'boolean',
|
|
52089
|
-
},
|
|
52090
|
-
left_open_alarm: {
|
|
52091
|
-
description: 'Indicates whether the door is left open.',
|
|
52092
|
-
type: 'boolean',
|
|
52093
|
-
},
|
|
52094
|
-
lock_type: {
|
|
52095
|
-
description: 'Type of the lock in the Salto KS access system.',
|
|
52096
|
-
type: 'string',
|
|
52097
|
-
},
|
|
52098
|
-
locked_state: {
|
|
52099
|
-
description: 'Locked state of the door in the Salto KS access system.',
|
|
52100
|
-
type: 'string',
|
|
52101
|
-
},
|
|
52102
|
-
online: {
|
|
52103
|
-
description: 'Indicates whether the door access device is online.',
|
|
52104
|
-
type: 'boolean',
|
|
52105
|
-
},
|
|
52106
|
-
privacy_mode: {
|
|
52107
|
-
description: 'Indicates whether privacy mode is enabled for the lock.',
|
|
52108
|
-
type: 'boolean',
|
|
52109
|
-
},
|
|
52110
|
-
},
|
|
52111
|
-
required: [
|
|
52112
|
-
'door_name',
|
|
52113
|
-
'locked_state',
|
|
52114
|
-
'lock_type',
|
|
52115
|
-
'battery_level',
|
|
52116
|
-
],
|
|
52117
|
-
type: 'object',
|
|
52118
|
-
},
|
|
52119
|
-
salto_space_metadata: {
|
|
52120
|
-
description: 'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52121
|
-
properties: {
|
|
52122
|
-
door_description: {
|
|
52123
|
-
description: 'Description of the door in the Salto Space access system.',
|
|
52124
|
-
type: 'string',
|
|
52125
|
-
},
|
|
52126
|
-
door_id: {
|
|
52127
|
-
description: 'Door ID in the Salto Space access system.',
|
|
52128
|
-
type: 'string',
|
|
52129
|
-
},
|
|
52130
|
-
door_name: {
|
|
52131
|
-
description: 'Name of the door in the Salto Space access system.',
|
|
52132
|
-
type: 'string',
|
|
52133
|
-
},
|
|
52134
|
-
ext_door_id: {
|
|
52135
|
-
deprecated: true,
|
|
52136
|
-
type: 'string',
|
|
52137
|
-
'x-deprecated': 'use door_id.',
|
|
52138
|
-
},
|
|
52139
|
-
room_description: {
|
|
52140
|
-
description: 'Description of the room in the Salto Space access system.',
|
|
52141
|
-
type: 'string',
|
|
52142
|
-
},
|
|
52143
|
-
room_name: {
|
|
52144
|
-
description: 'Name of the room in the Salto Space access system.',
|
|
52145
|
-
type: 'string',
|
|
52146
|
-
},
|
|
52147
|
-
},
|
|
52148
|
-
type: 'object',
|
|
52149
|
-
},
|
|
52150
|
-
space_ids: {
|
|
52151
|
-
items: { format: 'uuid', type: 'string' },
|
|
52152
|
-
type: 'array',
|
|
52153
|
-
},
|
|
52154
|
-
visionline_metadata: {
|
|
52155
|
-
description: 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52156
|
-
properties: {
|
|
52157
|
-
door_category: {
|
|
52158
|
-
description: 'Category of the door in the Visionline access system.',
|
|
52159
|
-
enum: [
|
|
52160
|
-
'entrance',
|
|
52161
|
-
'guest',
|
|
52162
|
-
'elevator reader',
|
|
52163
|
-
'common',
|
|
52164
|
-
'common (PMS)',
|
|
52165
|
-
],
|
|
52166
|
-
type: 'string',
|
|
52167
|
-
},
|
|
52168
|
-
door_name: {
|
|
52169
|
-
description: 'Name of the door in the Visionline access system.',
|
|
52170
|
-
type: 'string',
|
|
52171
|
-
},
|
|
52172
|
-
profiles: {
|
|
52173
|
-
description: 'Profile for the door in the Visionline access system.',
|
|
52174
|
-
items: {
|
|
52175
|
-
properties: {
|
|
52176
|
-
visionline_door_profile_id: {
|
|
52177
|
-
description: 'Door profile ID in the Visionline access system.',
|
|
52178
|
-
type: 'string',
|
|
52179
|
-
},
|
|
52180
|
-
visionline_door_profile_type: {
|
|
52181
|
-
description: 'Door profile type in the Visionline access system.',
|
|
52182
|
-
enum: ['BLE', 'commonDoor', 'touch'],
|
|
52183
|
-
type: 'string',
|
|
52184
|
-
},
|
|
52185
|
-
},
|
|
52186
|
-
required: [
|
|
52187
|
-
'visionline_door_profile_id',
|
|
52188
|
-
'visionline_door_profile_type',
|
|
52189
|
-
],
|
|
52190
|
-
type: 'object',
|
|
52191
|
-
},
|
|
52192
|
-
type: 'array',
|
|
52193
|
-
},
|
|
52194
|
-
},
|
|
52195
|
-
required: ['door_name', 'door_category'],
|
|
52196
|
-
type: 'object',
|
|
52197
|
-
},
|
|
52198
|
-
},
|
|
52199
|
-
required: [
|
|
52200
|
-
'acs_system_id',
|
|
52201
|
-
'acs_entrance_id',
|
|
52202
|
-
'created_at',
|
|
52203
|
-
'display_name',
|
|
52204
|
-
'connected_account_id',
|
|
52205
|
-
'errors',
|
|
52206
|
-
'space_ids',
|
|
52207
|
-
],
|
|
52208
|
-
type: 'object',
|
|
52209
|
-
'x-route-path': '/acs/entrances',
|
|
52210
|
-
},
|
|
51736
|
+
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
52211
51737
|
type: 'array',
|
|
52212
51738
|
},
|
|
52213
51739
|
acs_systems: {
|