@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
|
@@ -3065,6 +3065,11 @@ export default {
|
|
|
3065
3065
|
},
|
|
3066
3066
|
type: 'object',
|
|
3067
3067
|
},
|
|
3068
|
+
space_ids: {
|
|
3069
|
+
description: 'IDs of the spaces that the entrance is in.',
|
|
3070
|
+
items: { format: 'uuid', type: 'string' },
|
|
3071
|
+
type: 'array',
|
|
3072
|
+
},
|
|
3068
3073
|
visionline_metadata: {
|
|
3069
3074
|
description:
|
|
3070
3075
|
'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
@@ -3119,6 +3124,7 @@ export default {
|
|
|
3119
3124
|
required: [
|
|
3120
3125
|
'acs_system_id',
|
|
3121
3126
|
'acs_entrance_id',
|
|
3127
|
+
'space_ids',
|
|
3122
3128
|
'created_at',
|
|
3123
3129
|
'display_name',
|
|
3124
3130
|
'connected_account_id',
|
|
@@ -20031,6 +20037,12 @@ export default {
|
|
|
20031
20037
|
},
|
|
20032
20038
|
type: 'object',
|
|
20033
20039
|
},
|
|
20040
|
+
space_ids: {
|
|
20041
|
+
description:
|
|
20042
|
+
'IDs of the spaces that the entrance is in.',
|
|
20043
|
+
items: { format: 'uuid', type: 'string' },
|
|
20044
|
+
type: 'array',
|
|
20045
|
+
},
|
|
20034
20046
|
visionline_metadata: {
|
|
20035
20047
|
description:
|
|
20036
20048
|
'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
@@ -20085,6 +20097,7 @@ export default {
|
|
|
20085
20097
|
required: [
|
|
20086
20098
|
'acs_system_id',
|
|
20087
20099
|
'acs_entrance_id',
|
|
20100
|
+
'space_ids',
|
|
20088
20101
|
'created_at',
|
|
20089
20102
|
'display_name',
|
|
20090
20103
|
'connected_account_id',
|
|
@@ -38737,6 +38750,12 @@ export default {
|
|
|
38737
38750
|
'Whether to exclude this feature from the portal.',
|
|
38738
38751
|
type: 'boolean',
|
|
38739
38752
|
},
|
|
38753
|
+
excluded_providers: {
|
|
38754
|
+
description:
|
|
38755
|
+
'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
38756
|
+
items: { type: 'string' },
|
|
38757
|
+
type: 'array',
|
|
38758
|
+
},
|
|
38740
38759
|
},
|
|
38741
38760
|
type: 'object',
|
|
38742
38761
|
},
|
|
@@ -38784,59 +38803,96 @@ export default {
|
|
|
38784
38803
|
manage: {
|
|
38785
38804
|
oneOf: [
|
|
38786
38805
|
{
|
|
38787
|
-
|
|
38788
|
-
|
|
38789
|
-
|
|
38790
|
-
|
|
38791
|
-
|
|
38792
|
-
|
|
38793
|
-
|
|
38794
|
-
|
|
38795
|
-
|
|
38796
|
-
|
|
38797
|
-
|
|
38798
|
-
|
|
38799
|
-
|
|
38800
|
-
|
|
38801
|
-
|
|
38802
|
-
|
|
38803
|
-
|
|
38804
|
-
|
|
38805
|
-
|
|
38806
|
-
|
|
38807
|
-
|
|
38808
|
-
|
|
38809
|
-
|
|
38810
|
-
|
|
38811
|
-
|
|
38812
|
-
|
|
38813
|
-
|
|
38814
|
-
|
|
38815
|
-
|
|
38816
|
-
|
|
38817
|
-
|
|
38818
|
-
|
|
38819
|
-
|
|
38820
|
-
|
|
38821
|
-
|
|
38822
|
-
|
|
38823
|
-
|
|
38824
|
-
|
|
38825
|
-
|
|
38826
|
-
|
|
38827
|
-
|
|
38828
|
-
|
|
38829
|
-
|
|
38830
|
-
|
|
38831
|
-
|
|
38832
|
-
|
|
38806
|
+
oneOf: [
|
|
38807
|
+
{
|
|
38808
|
+
properties: {
|
|
38809
|
+
space_key: { type: 'string' },
|
|
38810
|
+
},
|
|
38811
|
+
required: ['space_key'],
|
|
38812
|
+
type: 'object',
|
|
38813
|
+
},
|
|
38814
|
+
{
|
|
38815
|
+
properties: {
|
|
38816
|
+
property_key: { type: 'string' },
|
|
38817
|
+
},
|
|
38818
|
+
required: ['property_key'],
|
|
38819
|
+
type: 'object',
|
|
38820
|
+
},
|
|
38821
|
+
{
|
|
38822
|
+
properties: {
|
|
38823
|
+
room_key: { type: 'string' },
|
|
38824
|
+
},
|
|
38825
|
+
required: ['room_key'],
|
|
38826
|
+
type: 'object',
|
|
38827
|
+
},
|
|
38828
|
+
{
|
|
38829
|
+
properties: {
|
|
38830
|
+
common_area_key: { type: 'string' },
|
|
38831
|
+
},
|
|
38832
|
+
required: ['common_area_key'],
|
|
38833
|
+
type: 'object',
|
|
38834
|
+
},
|
|
38835
|
+
{
|
|
38836
|
+
properties: {
|
|
38837
|
+
unit_key: { type: 'string' },
|
|
38838
|
+
},
|
|
38839
|
+
required: ['unit_key'],
|
|
38840
|
+
type: 'object',
|
|
38841
|
+
},
|
|
38842
|
+
{
|
|
38843
|
+
properties: {
|
|
38844
|
+
facility_key: { type: 'string' },
|
|
38845
|
+
},
|
|
38846
|
+
required: ['facility_key'],
|
|
38847
|
+
type: 'object',
|
|
38848
|
+
},
|
|
38849
|
+
{
|
|
38850
|
+
properties: {
|
|
38851
|
+
building_key: { type: 'string' },
|
|
38852
|
+
},
|
|
38853
|
+
required: ['building_key'],
|
|
38854
|
+
type: 'object',
|
|
38855
|
+
},
|
|
38856
|
+
{
|
|
38857
|
+
properties: {
|
|
38858
|
+
listing_key: { type: 'string' },
|
|
38859
|
+
},
|
|
38860
|
+
required: ['listing_key'],
|
|
38861
|
+
type: 'object',
|
|
38862
|
+
},
|
|
38863
|
+
{
|
|
38864
|
+
properties: {
|
|
38865
|
+
property_listing_key: { type: 'string' },
|
|
38866
|
+
},
|
|
38867
|
+
required: ['property_listing_key'],
|
|
38868
|
+
type: 'object',
|
|
38869
|
+
},
|
|
38870
|
+
],
|
|
38833
38871
|
},
|
|
38834
38872
|
{
|
|
38835
|
-
|
|
38836
|
-
|
|
38837
|
-
|
|
38838
|
-
|
|
38839
|
-
|
|
38873
|
+
oneOf: [
|
|
38874
|
+
{
|
|
38875
|
+
properties: {
|
|
38876
|
+
reservation_key: { type: 'string' },
|
|
38877
|
+
},
|
|
38878
|
+
required: ['reservation_key'],
|
|
38879
|
+
type: 'object',
|
|
38880
|
+
},
|
|
38881
|
+
{
|
|
38882
|
+
properties: {
|
|
38883
|
+
booking_key: { type: 'string' },
|
|
38884
|
+
},
|
|
38885
|
+
required: ['booking_key'],
|
|
38886
|
+
type: 'object',
|
|
38887
|
+
},
|
|
38888
|
+
{
|
|
38889
|
+
properties: {
|
|
38890
|
+
access_grant_key: { type: 'string' },
|
|
38891
|
+
},
|
|
38892
|
+
required: ['access_grant_key'],
|
|
38893
|
+
type: 'object',
|
|
38894
|
+
},
|
|
38895
|
+
],
|
|
38840
38896
|
},
|
|
38841
38897
|
],
|
|
38842
38898
|
},
|
|
@@ -49718,7 +49774,13 @@ export default {
|
|
|
49718
49774
|
type: 'object',
|
|
49719
49775
|
},
|
|
49720
49776
|
connect: {
|
|
49721
|
-
properties: {
|
|
49777
|
+
properties: {
|
|
49778
|
+
exclude: { type: 'boolean' },
|
|
49779
|
+
excluded_providers: {
|
|
49780
|
+
items: { type: 'string' },
|
|
49781
|
+
type: 'array',
|
|
49782
|
+
},
|
|
49783
|
+
},
|
|
49722
49784
|
type: 'object',
|
|
49723
49785
|
},
|
|
49724
49786
|
manage_devices: {
|
|
@@ -49738,61 +49800,98 @@ export default {
|
|
|
49738
49800
|
manage: {
|
|
49739
49801
|
oneOf: [
|
|
49740
49802
|
{
|
|
49741
|
-
|
|
49742
|
-
|
|
49743
|
-
|
|
49744
|
-
|
|
49745
|
-
|
|
49746
|
-
|
|
49747
|
-
|
|
49748
|
-
|
|
49749
|
-
|
|
49750
|
-
|
|
49751
|
-
|
|
49752
|
-
|
|
49753
|
-
|
|
49754
|
-
|
|
49755
|
-
|
|
49756
|
-
|
|
49757
|
-
|
|
49758
|
-
|
|
49759
|
-
|
|
49760
|
-
|
|
49761
|
-
|
|
49762
|
-
|
|
49763
|
-
|
|
49764
|
-
|
|
49765
|
-
|
|
49766
|
-
|
|
49767
|
-
|
|
49768
|
-
|
|
49769
|
-
|
|
49770
|
-
|
|
49771
|
-
|
|
49772
|
-
|
|
49773
|
-
|
|
49774
|
-
|
|
49775
|
-
|
|
49776
|
-
|
|
49777
|
-
|
|
49778
|
-
|
|
49779
|
-
|
|
49780
|
-
|
|
49781
|
-
|
|
49782
|
-
|
|
49783
|
-
|
|
49784
|
-
|
|
49785
|
-
|
|
49786
|
-
|
|
49787
|
-
|
|
49788
|
-
|
|
49803
|
+
oneOf: [
|
|
49804
|
+
{
|
|
49805
|
+
properties: {
|
|
49806
|
+
space_key: { type: 'string' },
|
|
49807
|
+
},
|
|
49808
|
+
required: ['space_key'],
|
|
49809
|
+
type: 'object',
|
|
49810
|
+
},
|
|
49811
|
+
{
|
|
49812
|
+
properties: {
|
|
49813
|
+
property_key: { type: 'string' },
|
|
49814
|
+
},
|
|
49815
|
+
required: ['property_key'],
|
|
49816
|
+
type: 'object',
|
|
49817
|
+
},
|
|
49818
|
+
{
|
|
49819
|
+
properties: {
|
|
49820
|
+
room_key: { type: 'string' },
|
|
49821
|
+
},
|
|
49822
|
+
required: ['room_key'],
|
|
49823
|
+
type: 'object',
|
|
49824
|
+
},
|
|
49825
|
+
{
|
|
49826
|
+
properties: {
|
|
49827
|
+
common_area_key: { type: 'string' },
|
|
49828
|
+
},
|
|
49829
|
+
required: ['common_area_key'],
|
|
49830
|
+
type: 'object',
|
|
49831
|
+
},
|
|
49832
|
+
{
|
|
49833
|
+
properties: {
|
|
49834
|
+
unit_key: { type: 'string' },
|
|
49835
|
+
},
|
|
49836
|
+
required: ['unit_key'],
|
|
49837
|
+
type: 'object',
|
|
49838
|
+
},
|
|
49839
|
+
{
|
|
49840
|
+
properties: {
|
|
49841
|
+
facility_key: { type: 'string' },
|
|
49842
|
+
},
|
|
49843
|
+
required: ['facility_key'],
|
|
49844
|
+
type: 'object',
|
|
49845
|
+
},
|
|
49846
|
+
{
|
|
49847
|
+
properties: {
|
|
49848
|
+
building_key: { type: 'string' },
|
|
49849
|
+
},
|
|
49850
|
+
required: ['building_key'],
|
|
49851
|
+
type: 'object',
|
|
49852
|
+
},
|
|
49853
|
+
{
|
|
49854
|
+
properties: {
|
|
49855
|
+
listing_key: { type: 'string' },
|
|
49856
|
+
},
|
|
49857
|
+
required: ['listing_key'],
|
|
49858
|
+
type: 'object',
|
|
49859
|
+
},
|
|
49860
|
+
{
|
|
49861
|
+
properties: {
|
|
49862
|
+
property_listing_key: {
|
|
49863
|
+
type: 'string',
|
|
49864
|
+
},
|
|
49865
|
+
},
|
|
49866
|
+
required: ['property_listing_key'],
|
|
49867
|
+
type: 'object',
|
|
49868
|
+
},
|
|
49869
|
+
],
|
|
49789
49870
|
},
|
|
49790
49871
|
{
|
|
49791
|
-
|
|
49792
|
-
|
|
49793
|
-
|
|
49794
|
-
|
|
49795
|
-
|
|
49872
|
+
oneOf: [
|
|
49873
|
+
{
|
|
49874
|
+
properties: {
|
|
49875
|
+
reservation_key: { type: 'string' },
|
|
49876
|
+
},
|
|
49877
|
+
required: ['reservation_key'],
|
|
49878
|
+
type: 'object',
|
|
49879
|
+
},
|
|
49880
|
+
{
|
|
49881
|
+
properties: {
|
|
49882
|
+
booking_key: { type: 'string' },
|
|
49883
|
+
},
|
|
49884
|
+
required: ['booking_key'],
|
|
49885
|
+
type: 'object',
|
|
49886
|
+
},
|
|
49887
|
+
{
|
|
49888
|
+
properties: {
|
|
49889
|
+
access_grant_key: { type: 'string' },
|
|
49890
|
+
},
|
|
49891
|
+
required: ['access_grant_key'],
|
|
49892
|
+
type: 'object',
|
|
49893
|
+
},
|
|
49894
|
+
],
|
|
49796
49895
|
},
|
|
49797
49896
|
],
|
|
49798
49897
|
},
|
|
@@ -49880,7 +49979,13 @@ export default {
|
|
|
49880
49979
|
type: 'object',
|
|
49881
49980
|
},
|
|
49882
49981
|
connect: {
|
|
49883
|
-
properties: {
|
|
49982
|
+
properties: {
|
|
49983
|
+
exclude: { type: 'boolean' },
|
|
49984
|
+
excluded_providers: {
|
|
49985
|
+
items: { type: 'string' },
|
|
49986
|
+
type: 'array',
|
|
49987
|
+
},
|
|
49988
|
+
},
|
|
49884
49989
|
type: 'object',
|
|
49885
49990
|
},
|
|
49886
49991
|
manage_devices: {
|
|
@@ -49900,61 +50005,98 @@ export default {
|
|
|
49900
50005
|
manage: {
|
|
49901
50006
|
oneOf: [
|
|
49902
50007
|
{
|
|
49903
|
-
|
|
49904
|
-
|
|
49905
|
-
|
|
49906
|
-
|
|
49907
|
-
|
|
49908
|
-
|
|
49909
|
-
|
|
49910
|
-
|
|
49911
|
-
|
|
49912
|
-
|
|
49913
|
-
|
|
49914
|
-
|
|
49915
|
-
|
|
49916
|
-
|
|
49917
|
-
|
|
49918
|
-
|
|
49919
|
-
|
|
49920
|
-
|
|
49921
|
-
|
|
49922
|
-
|
|
49923
|
-
|
|
49924
|
-
|
|
49925
|
-
|
|
49926
|
-
|
|
49927
|
-
|
|
49928
|
-
|
|
49929
|
-
|
|
49930
|
-
|
|
49931
|
-
|
|
49932
|
-
|
|
49933
|
-
|
|
49934
|
-
|
|
49935
|
-
|
|
49936
|
-
|
|
49937
|
-
|
|
49938
|
-
|
|
49939
|
-
|
|
49940
|
-
|
|
49941
|
-
|
|
49942
|
-
|
|
49943
|
-
|
|
49944
|
-
|
|
49945
|
-
|
|
49946
|
-
|
|
49947
|
-
|
|
49948
|
-
|
|
49949
|
-
|
|
49950
|
-
|
|
50008
|
+
oneOf: [
|
|
50009
|
+
{
|
|
50010
|
+
properties: {
|
|
50011
|
+
space_key: { type: 'string' },
|
|
50012
|
+
},
|
|
50013
|
+
required: ['space_key'],
|
|
50014
|
+
type: 'object',
|
|
50015
|
+
},
|
|
50016
|
+
{
|
|
50017
|
+
properties: {
|
|
50018
|
+
property_key: { type: 'string' },
|
|
50019
|
+
},
|
|
50020
|
+
required: ['property_key'],
|
|
50021
|
+
type: 'object',
|
|
50022
|
+
},
|
|
50023
|
+
{
|
|
50024
|
+
properties: {
|
|
50025
|
+
room_key: { type: 'string' },
|
|
50026
|
+
},
|
|
50027
|
+
required: ['room_key'],
|
|
50028
|
+
type: 'object',
|
|
50029
|
+
},
|
|
50030
|
+
{
|
|
50031
|
+
properties: {
|
|
50032
|
+
common_area_key: { type: 'string' },
|
|
50033
|
+
},
|
|
50034
|
+
required: ['common_area_key'],
|
|
50035
|
+
type: 'object',
|
|
50036
|
+
},
|
|
50037
|
+
{
|
|
50038
|
+
properties: {
|
|
50039
|
+
unit_key: { type: 'string' },
|
|
50040
|
+
},
|
|
50041
|
+
required: ['unit_key'],
|
|
50042
|
+
type: 'object',
|
|
50043
|
+
},
|
|
50044
|
+
{
|
|
50045
|
+
properties: {
|
|
50046
|
+
facility_key: { type: 'string' },
|
|
50047
|
+
},
|
|
50048
|
+
required: ['facility_key'],
|
|
50049
|
+
type: 'object',
|
|
50050
|
+
},
|
|
50051
|
+
{
|
|
50052
|
+
properties: {
|
|
50053
|
+
building_key: { type: 'string' },
|
|
50054
|
+
},
|
|
50055
|
+
required: ['building_key'],
|
|
50056
|
+
type: 'object',
|
|
50057
|
+
},
|
|
50058
|
+
{
|
|
50059
|
+
properties: {
|
|
50060
|
+
listing_key: { type: 'string' },
|
|
50061
|
+
},
|
|
50062
|
+
required: ['listing_key'],
|
|
50063
|
+
type: 'object',
|
|
50064
|
+
},
|
|
50065
|
+
{
|
|
50066
|
+
properties: {
|
|
50067
|
+
property_listing_key: {
|
|
50068
|
+
type: 'string',
|
|
50069
|
+
},
|
|
50070
|
+
},
|
|
50071
|
+
required: ['property_listing_key'],
|
|
50072
|
+
type: 'object',
|
|
50073
|
+
},
|
|
50074
|
+
],
|
|
49951
50075
|
},
|
|
49952
50076
|
{
|
|
49953
|
-
|
|
49954
|
-
|
|
49955
|
-
|
|
49956
|
-
|
|
49957
|
-
|
|
50077
|
+
oneOf: [
|
|
50078
|
+
{
|
|
50079
|
+
properties: {
|
|
50080
|
+
reservation_key: { type: 'string' },
|
|
50081
|
+
},
|
|
50082
|
+
required: ['reservation_key'],
|
|
50083
|
+
type: 'object',
|
|
50084
|
+
},
|
|
50085
|
+
{
|
|
50086
|
+
properties: {
|
|
50087
|
+
booking_key: { type: 'string' },
|
|
50088
|
+
},
|
|
50089
|
+
required: ['booking_key'],
|
|
50090
|
+
type: 'object',
|
|
50091
|
+
},
|
|
50092
|
+
{
|
|
50093
|
+
properties: {
|
|
50094
|
+
access_grant_key: { type: 'string' },
|
|
50095
|
+
},
|
|
50096
|
+
required: ['access_grant_key'],
|
|
50097
|
+
type: 'object',
|
|
50098
|
+
},
|
|
50099
|
+
],
|
|
49958
50100
|
},
|
|
49959
50101
|
],
|
|
49960
50102
|
},
|
|
@@ -51952,365 +52094,7 @@ export default {
|
|
|
51952
52094
|
description: 'ID of the affected access system user.',
|
|
51953
52095
|
properties: {
|
|
51954
52096
|
acs_entrances: {
|
|
51955
|
-
items: {
|
|
51956
|
-
description:
|
|
51957
|
-
'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.',
|
|
51958
|
-
properties: {
|
|
51959
|
-
acs_entrance_id: {
|
|
51960
|
-
description:
|
|
51961
|
-
'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51962
|
-
format: 'uuid',
|
|
51963
|
-
type: 'string',
|
|
51964
|
-
},
|
|
51965
|
-
acs_system_id: {
|
|
51966
|
-
description:
|
|
51967
|
-
'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).',
|
|
51968
|
-
format: 'uuid',
|
|
51969
|
-
type: 'string',
|
|
51970
|
-
},
|
|
51971
|
-
assa_abloy_vostio_metadata: {
|
|
51972
|
-
description:
|
|
51973
|
-
'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
51974
|
-
properties: {
|
|
51975
|
-
door_name: {
|
|
51976
|
-
description:
|
|
51977
|
-
'Name of the door in the Vostio access system.',
|
|
51978
|
-
type: 'string',
|
|
51979
|
-
},
|
|
51980
|
-
door_number: {
|
|
51981
|
-
description:
|
|
51982
|
-
'Number of the door in the Vostio access system.',
|
|
51983
|
-
format: 'float',
|
|
51984
|
-
type: 'number',
|
|
51985
|
-
},
|
|
51986
|
-
door_type: {
|
|
51987
|
-
description:
|
|
51988
|
-
'Type of the door in the Vostio access system.',
|
|
51989
|
-
enum: [
|
|
51990
|
-
'CommonDoor',
|
|
51991
|
-
'EntranceDoor',
|
|
51992
|
-
'GuestDoor',
|
|
51993
|
-
'Elevator',
|
|
51994
|
-
],
|
|
51995
|
-
type: 'string',
|
|
51996
|
-
},
|
|
51997
|
-
pms_id: {
|
|
51998
|
-
description:
|
|
51999
|
-
'PMS ID of the door in the Vostio access system.',
|
|
52000
|
-
type: 'string',
|
|
52001
|
-
},
|
|
52002
|
-
stand_open: {
|
|
52003
|
-
description:
|
|
52004
|
-
'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.',
|
|
52005
|
-
type: 'boolean',
|
|
52006
|
-
},
|
|
52007
|
-
},
|
|
52008
|
-
required: ['door_type', 'door_name'],
|
|
52009
|
-
type: 'object',
|
|
52010
|
-
},
|
|
52011
|
-
can_unlock_with_card: {
|
|
52012
|
-
description:
|
|
52013
|
-
'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
52014
|
-
type: 'boolean',
|
|
52015
|
-
},
|
|
52016
|
-
can_unlock_with_code: {
|
|
52017
|
-
description:
|
|
52018
|
-
'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
52019
|
-
type: 'boolean',
|
|
52020
|
-
},
|
|
52021
|
-
can_unlock_with_mobile_key: {
|
|
52022
|
-
description:
|
|
52023
|
-
'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
|
|
52024
|
-
type: 'boolean',
|
|
52025
|
-
},
|
|
52026
|
-
connected_account_id: {
|
|
52027
|
-
description:
|
|
52028
|
-
'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).',
|
|
52029
|
-
format: 'uuid',
|
|
52030
|
-
type: 'string',
|
|
52031
|
-
},
|
|
52032
|
-
created_at: {
|
|
52033
|
-
description:
|
|
52034
|
-
'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
52035
|
-
format: 'date-time',
|
|
52036
|
-
type: 'string',
|
|
52037
|
-
},
|
|
52038
|
-
display_name: {
|
|
52039
|
-
description:
|
|
52040
|
-
'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52041
|
-
type: 'string',
|
|
52042
|
-
},
|
|
52043
|
-
dormakaba_ambiance_metadata: {
|
|
52044
|
-
description:
|
|
52045
|
-
'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52046
|
-
properties: {
|
|
52047
|
-
access_point_name: {
|
|
52048
|
-
description:
|
|
52049
|
-
'Name of the access point in the dormakaba Ambiance access system.',
|
|
52050
|
-
type: 'string',
|
|
52051
|
-
},
|
|
52052
|
-
},
|
|
52053
|
-
required: ['access_point_name'],
|
|
52054
|
-
type: 'object',
|
|
52055
|
-
},
|
|
52056
|
-
dormakaba_community_metadata: {
|
|
52057
|
-
description:
|
|
52058
|
-
'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52059
|
-
properties: {
|
|
52060
|
-
access_point_name: {
|
|
52061
|
-
description:
|
|
52062
|
-
'Name of the access point in the dormakaba Community access system.',
|
|
52063
|
-
type: 'string',
|
|
52064
|
-
},
|
|
52065
|
-
access_point_profile: {
|
|
52066
|
-
description:
|
|
52067
|
-
'Type of access point profile in the dormakaba Community access system.',
|
|
52068
|
-
type: 'string',
|
|
52069
|
-
},
|
|
52070
|
-
},
|
|
52071
|
-
required: [
|
|
52072
|
-
'access_point_name',
|
|
52073
|
-
'access_point_profile',
|
|
52074
|
-
],
|
|
52075
|
-
type: 'object',
|
|
52076
|
-
},
|
|
52077
|
-
errors: {
|
|
52078
|
-
description:
|
|
52079
|
-
'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52080
|
-
items: {
|
|
52081
|
-
properties: {
|
|
52082
|
-
error_code: {
|
|
52083
|
-
description:
|
|
52084
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
52085
|
-
type: 'string',
|
|
52086
|
-
},
|
|
52087
|
-
message: {
|
|
52088
|
-
description:
|
|
52089
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
52090
|
-
type: 'string',
|
|
52091
|
-
},
|
|
52092
|
-
},
|
|
52093
|
-
required: ['error_code', 'message'],
|
|
52094
|
-
type: 'object',
|
|
52095
|
-
},
|
|
52096
|
-
type: 'array',
|
|
52097
|
-
},
|
|
52098
|
-
hotek_metadata: {
|
|
52099
|
-
description:
|
|
52100
|
-
'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52101
|
-
properties: {
|
|
52102
|
-
display_name: {
|
|
52103
|
-
description:
|
|
52104
|
-
'Display name of the entrance.',
|
|
52105
|
-
type: 'string',
|
|
52106
|
-
},
|
|
52107
|
-
door_type: {
|
|
52108
|
-
description: 'Type of door.',
|
|
52109
|
-
enum: ['common_area', 'guest'],
|
|
52110
|
-
type: 'string',
|
|
52111
|
-
},
|
|
52112
|
-
room_number: {
|
|
52113
|
-
description: 'Room number of the entrance.',
|
|
52114
|
-
type: 'string',
|
|
52115
|
-
},
|
|
52116
|
-
},
|
|
52117
|
-
required: [
|
|
52118
|
-
'room_number',
|
|
52119
|
-
'display_name',
|
|
52120
|
-
'door_type',
|
|
52121
|
-
],
|
|
52122
|
-
type: 'object',
|
|
52123
|
-
},
|
|
52124
|
-
latch_metadata: {
|
|
52125
|
-
description:
|
|
52126
|
-
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52127
|
-
properties: {
|
|
52128
|
-
accessibility_type: {
|
|
52129
|
-
description:
|
|
52130
|
-
'Accessibility type in the Latch access system.',
|
|
52131
|
-
type: 'string',
|
|
52132
|
-
},
|
|
52133
|
-
door_name: {
|
|
52134
|
-
description:
|
|
52135
|
-
'Name of the door in the Latch access system.',
|
|
52136
|
-
type: 'string',
|
|
52137
|
-
},
|
|
52138
|
-
door_type: {
|
|
52139
|
-
description:
|
|
52140
|
-
'Type of the door in the Latch access system.',
|
|
52141
|
-
type: 'string',
|
|
52142
|
-
},
|
|
52143
|
-
is_connected: {
|
|
52144
|
-
description:
|
|
52145
|
-
'Indicates whether the entrance is connected.',
|
|
52146
|
-
type: 'boolean',
|
|
52147
|
-
},
|
|
52148
|
-
},
|
|
52149
|
-
required: [
|
|
52150
|
-
'accessibility_type',
|
|
52151
|
-
'door_name',
|
|
52152
|
-
'door_type',
|
|
52153
|
-
'is_connected',
|
|
52154
|
-
],
|
|
52155
|
-
type: 'object',
|
|
52156
|
-
},
|
|
52157
|
-
salto_ks_metadata: {
|
|
52158
|
-
description:
|
|
52159
|
-
'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52160
|
-
properties: {
|
|
52161
|
-
battery_level: {
|
|
52162
|
-
description:
|
|
52163
|
-
'Battery level of the door access device.',
|
|
52164
|
-
type: 'string',
|
|
52165
|
-
},
|
|
52166
|
-
door_name: {
|
|
52167
|
-
description:
|
|
52168
|
-
'Name of the door in the Salto KS access system.',
|
|
52169
|
-
type: 'string',
|
|
52170
|
-
},
|
|
52171
|
-
intrusion_alarm: {
|
|
52172
|
-
description:
|
|
52173
|
-
'Indicates whether an intrusion alarm is active on the door.',
|
|
52174
|
-
type: 'boolean',
|
|
52175
|
-
},
|
|
52176
|
-
left_open_alarm: {
|
|
52177
|
-
description:
|
|
52178
|
-
'Indicates whether the door is left open.',
|
|
52179
|
-
type: 'boolean',
|
|
52180
|
-
},
|
|
52181
|
-
lock_type: {
|
|
52182
|
-
description:
|
|
52183
|
-
'Type of the lock in the Salto KS access system.',
|
|
52184
|
-
type: 'string',
|
|
52185
|
-
},
|
|
52186
|
-
locked_state: {
|
|
52187
|
-
description:
|
|
52188
|
-
'Locked state of the door in the Salto KS access system.',
|
|
52189
|
-
type: 'string',
|
|
52190
|
-
},
|
|
52191
|
-
online: {
|
|
52192
|
-
description:
|
|
52193
|
-
'Indicates whether the door access device is online.',
|
|
52194
|
-
type: 'boolean',
|
|
52195
|
-
},
|
|
52196
|
-
privacy_mode: {
|
|
52197
|
-
description:
|
|
52198
|
-
'Indicates whether privacy mode is enabled for the lock.',
|
|
52199
|
-
type: 'boolean',
|
|
52200
|
-
},
|
|
52201
|
-
},
|
|
52202
|
-
required: [
|
|
52203
|
-
'door_name',
|
|
52204
|
-
'locked_state',
|
|
52205
|
-
'lock_type',
|
|
52206
|
-
'battery_level',
|
|
52207
|
-
],
|
|
52208
|
-
type: 'object',
|
|
52209
|
-
},
|
|
52210
|
-
salto_space_metadata: {
|
|
52211
|
-
description:
|
|
52212
|
-
'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52213
|
-
properties: {
|
|
52214
|
-
door_description: {
|
|
52215
|
-
description:
|
|
52216
|
-
'Description of the door in the Salto Space access system.',
|
|
52217
|
-
type: 'string',
|
|
52218
|
-
},
|
|
52219
|
-
door_id: {
|
|
52220
|
-
description:
|
|
52221
|
-
'Door ID in the Salto Space access system.',
|
|
52222
|
-
type: 'string',
|
|
52223
|
-
},
|
|
52224
|
-
door_name: {
|
|
52225
|
-
description:
|
|
52226
|
-
'Name of the door in the Salto Space access system.',
|
|
52227
|
-
type: 'string',
|
|
52228
|
-
},
|
|
52229
|
-
ext_door_id: {
|
|
52230
|
-
deprecated: true,
|
|
52231
|
-
type: 'string',
|
|
52232
|
-
'x-deprecated': 'use door_id.',
|
|
52233
|
-
},
|
|
52234
|
-
room_description: {
|
|
52235
|
-
description:
|
|
52236
|
-
'Description of the room in the Salto Space access system.',
|
|
52237
|
-
type: 'string',
|
|
52238
|
-
},
|
|
52239
|
-
room_name: {
|
|
52240
|
-
description:
|
|
52241
|
-
'Name of the room in the Salto Space access system.',
|
|
52242
|
-
type: 'string',
|
|
52243
|
-
},
|
|
52244
|
-
},
|
|
52245
|
-
type: 'object',
|
|
52246
|
-
},
|
|
52247
|
-
space_ids: {
|
|
52248
|
-
items: { format: 'uuid', type: 'string' },
|
|
52249
|
-
type: 'array',
|
|
52250
|
-
},
|
|
52251
|
-
visionline_metadata: {
|
|
52252
|
-
description:
|
|
52253
|
-
'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
52254
|
-
properties: {
|
|
52255
|
-
door_category: {
|
|
52256
|
-
description:
|
|
52257
|
-
'Category of the door in the Visionline access system.',
|
|
52258
|
-
enum: [
|
|
52259
|
-
'entrance',
|
|
52260
|
-
'guest',
|
|
52261
|
-
'elevator reader',
|
|
52262
|
-
'common',
|
|
52263
|
-
'common (PMS)',
|
|
52264
|
-
],
|
|
52265
|
-
type: 'string',
|
|
52266
|
-
},
|
|
52267
|
-
door_name: {
|
|
52268
|
-
description:
|
|
52269
|
-
'Name of the door in the Visionline access system.',
|
|
52270
|
-
type: 'string',
|
|
52271
|
-
},
|
|
52272
|
-
profiles: {
|
|
52273
|
-
description:
|
|
52274
|
-
'Profile for the door in the Visionline access system.',
|
|
52275
|
-
items: {
|
|
52276
|
-
properties: {
|
|
52277
|
-
visionline_door_profile_id: {
|
|
52278
|
-
description:
|
|
52279
|
-
'Door profile ID in the Visionline access system.',
|
|
52280
|
-
type: 'string',
|
|
52281
|
-
},
|
|
52282
|
-
visionline_door_profile_type: {
|
|
52283
|
-
description:
|
|
52284
|
-
'Door profile type in the Visionline access system.',
|
|
52285
|
-
enum: ['BLE', 'commonDoor', 'touch'],
|
|
52286
|
-
type: 'string',
|
|
52287
|
-
},
|
|
52288
|
-
},
|
|
52289
|
-
required: [
|
|
52290
|
-
'visionline_door_profile_id',
|
|
52291
|
-
'visionline_door_profile_type',
|
|
52292
|
-
],
|
|
52293
|
-
type: 'object',
|
|
52294
|
-
},
|
|
52295
|
-
type: 'array',
|
|
52296
|
-
},
|
|
52297
|
-
},
|
|
52298
|
-
required: ['door_name', 'door_category'],
|
|
52299
|
-
type: 'object',
|
|
52300
|
-
},
|
|
52301
|
-
},
|
|
52302
|
-
required: [
|
|
52303
|
-
'acs_system_id',
|
|
52304
|
-
'acs_entrance_id',
|
|
52305
|
-
'created_at',
|
|
52306
|
-
'display_name',
|
|
52307
|
-
'connected_account_id',
|
|
52308
|
-
'errors',
|
|
52309
|
-
'space_ids',
|
|
52310
|
-
],
|
|
52311
|
-
type: 'object',
|
|
52312
|
-
'x-route-path': '/acs/entrances',
|
|
52313
|
-
},
|
|
52097
|
+
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
52314
52098
|
type: 'array',
|
|
52315
52099
|
},
|
|
52316
52100
|
acs_systems: {
|
|
@@ -56557,365 +56341,7 @@ export default {
|
|
|
56557
56341
|
description: 'ID of the affected access system user.',
|
|
56558
56342
|
properties: {
|
|
56559
56343
|
acs_entrances: {
|
|
56560
|
-
items: {
|
|
56561
|
-
description:
|
|
56562
|
-
'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.',
|
|
56563
|
-
properties: {
|
|
56564
|
-
acs_entrance_id: {
|
|
56565
|
-
description:
|
|
56566
|
-
'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56567
|
-
format: 'uuid',
|
|
56568
|
-
type: 'string',
|
|
56569
|
-
},
|
|
56570
|
-
acs_system_id: {
|
|
56571
|
-
description:
|
|
56572
|
-
'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).',
|
|
56573
|
-
format: 'uuid',
|
|
56574
|
-
type: 'string',
|
|
56575
|
-
},
|
|
56576
|
-
assa_abloy_vostio_metadata: {
|
|
56577
|
-
description:
|
|
56578
|
-
'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56579
|
-
properties: {
|
|
56580
|
-
door_name: {
|
|
56581
|
-
description:
|
|
56582
|
-
'Name of the door in the Vostio access system.',
|
|
56583
|
-
type: 'string',
|
|
56584
|
-
},
|
|
56585
|
-
door_number: {
|
|
56586
|
-
description:
|
|
56587
|
-
'Number of the door in the Vostio access system.',
|
|
56588
|
-
format: 'float',
|
|
56589
|
-
type: 'number',
|
|
56590
|
-
},
|
|
56591
|
-
door_type: {
|
|
56592
|
-
description:
|
|
56593
|
-
'Type of the door in the Vostio access system.',
|
|
56594
|
-
enum: [
|
|
56595
|
-
'CommonDoor',
|
|
56596
|
-
'EntranceDoor',
|
|
56597
|
-
'GuestDoor',
|
|
56598
|
-
'Elevator',
|
|
56599
|
-
],
|
|
56600
|
-
type: 'string',
|
|
56601
|
-
},
|
|
56602
|
-
pms_id: {
|
|
56603
|
-
description:
|
|
56604
|
-
'PMS ID of the door in the Vostio access system.',
|
|
56605
|
-
type: 'string',
|
|
56606
|
-
},
|
|
56607
|
-
stand_open: {
|
|
56608
|
-
description:
|
|
56609
|
-
'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.',
|
|
56610
|
-
type: 'boolean',
|
|
56611
|
-
},
|
|
56612
|
-
},
|
|
56613
|
-
required: ['door_type', 'door_name'],
|
|
56614
|
-
type: 'object',
|
|
56615
|
-
},
|
|
56616
|
-
can_unlock_with_card: {
|
|
56617
|
-
description:
|
|
56618
|
-
'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
56619
|
-
type: 'boolean',
|
|
56620
|
-
},
|
|
56621
|
-
can_unlock_with_code: {
|
|
56622
|
-
description:
|
|
56623
|
-
'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
56624
|
-
type: 'boolean',
|
|
56625
|
-
},
|
|
56626
|
-
can_unlock_with_mobile_key: {
|
|
56627
|
-
description:
|
|
56628
|
-
'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
|
|
56629
|
-
type: 'boolean',
|
|
56630
|
-
},
|
|
56631
|
-
connected_account_id: {
|
|
56632
|
-
description:
|
|
56633
|
-
'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).',
|
|
56634
|
-
format: 'uuid',
|
|
56635
|
-
type: 'string',
|
|
56636
|
-
},
|
|
56637
|
-
created_at: {
|
|
56638
|
-
description:
|
|
56639
|
-
'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
56640
|
-
format: 'date-time',
|
|
56641
|
-
type: 'string',
|
|
56642
|
-
},
|
|
56643
|
-
display_name: {
|
|
56644
|
-
description:
|
|
56645
|
-
'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56646
|
-
type: 'string',
|
|
56647
|
-
},
|
|
56648
|
-
dormakaba_ambiance_metadata: {
|
|
56649
|
-
description:
|
|
56650
|
-
'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56651
|
-
properties: {
|
|
56652
|
-
access_point_name: {
|
|
56653
|
-
description:
|
|
56654
|
-
'Name of the access point in the dormakaba Ambiance access system.',
|
|
56655
|
-
type: 'string',
|
|
56656
|
-
},
|
|
56657
|
-
},
|
|
56658
|
-
required: ['access_point_name'],
|
|
56659
|
-
type: 'object',
|
|
56660
|
-
},
|
|
56661
|
-
dormakaba_community_metadata: {
|
|
56662
|
-
description:
|
|
56663
|
-
'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56664
|
-
properties: {
|
|
56665
|
-
access_point_name: {
|
|
56666
|
-
description:
|
|
56667
|
-
'Name of the access point in the dormakaba Community access system.',
|
|
56668
|
-
type: 'string',
|
|
56669
|
-
},
|
|
56670
|
-
access_point_profile: {
|
|
56671
|
-
description:
|
|
56672
|
-
'Type of access point profile in the dormakaba Community access system.',
|
|
56673
|
-
type: 'string',
|
|
56674
|
-
},
|
|
56675
|
-
},
|
|
56676
|
-
required: [
|
|
56677
|
-
'access_point_name',
|
|
56678
|
-
'access_point_profile',
|
|
56679
|
-
],
|
|
56680
|
-
type: 'object',
|
|
56681
|
-
},
|
|
56682
|
-
errors: {
|
|
56683
|
-
description:
|
|
56684
|
-
'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56685
|
-
items: {
|
|
56686
|
-
properties: {
|
|
56687
|
-
error_code: {
|
|
56688
|
-
description:
|
|
56689
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
56690
|
-
type: 'string',
|
|
56691
|
-
},
|
|
56692
|
-
message: {
|
|
56693
|
-
description:
|
|
56694
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
56695
|
-
type: 'string',
|
|
56696
|
-
},
|
|
56697
|
-
},
|
|
56698
|
-
required: ['error_code', 'message'],
|
|
56699
|
-
type: 'object',
|
|
56700
|
-
},
|
|
56701
|
-
type: 'array',
|
|
56702
|
-
},
|
|
56703
|
-
hotek_metadata: {
|
|
56704
|
-
description:
|
|
56705
|
-
'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56706
|
-
properties: {
|
|
56707
|
-
display_name: {
|
|
56708
|
-
description:
|
|
56709
|
-
'Display name of the entrance.',
|
|
56710
|
-
type: 'string',
|
|
56711
|
-
},
|
|
56712
|
-
door_type: {
|
|
56713
|
-
description: 'Type of door.',
|
|
56714
|
-
enum: ['common_area', 'guest'],
|
|
56715
|
-
type: 'string',
|
|
56716
|
-
},
|
|
56717
|
-
room_number: {
|
|
56718
|
-
description: 'Room number of the entrance.',
|
|
56719
|
-
type: 'string',
|
|
56720
|
-
},
|
|
56721
|
-
},
|
|
56722
|
-
required: [
|
|
56723
|
-
'room_number',
|
|
56724
|
-
'display_name',
|
|
56725
|
-
'door_type',
|
|
56726
|
-
],
|
|
56727
|
-
type: 'object',
|
|
56728
|
-
},
|
|
56729
|
-
latch_metadata: {
|
|
56730
|
-
description:
|
|
56731
|
-
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56732
|
-
properties: {
|
|
56733
|
-
accessibility_type: {
|
|
56734
|
-
description:
|
|
56735
|
-
'Accessibility type in the Latch access system.',
|
|
56736
|
-
type: 'string',
|
|
56737
|
-
},
|
|
56738
|
-
door_name: {
|
|
56739
|
-
description:
|
|
56740
|
-
'Name of the door in the Latch access system.',
|
|
56741
|
-
type: 'string',
|
|
56742
|
-
},
|
|
56743
|
-
door_type: {
|
|
56744
|
-
description:
|
|
56745
|
-
'Type of the door in the Latch access system.',
|
|
56746
|
-
type: 'string',
|
|
56747
|
-
},
|
|
56748
|
-
is_connected: {
|
|
56749
|
-
description:
|
|
56750
|
-
'Indicates whether the entrance is connected.',
|
|
56751
|
-
type: 'boolean',
|
|
56752
|
-
},
|
|
56753
|
-
},
|
|
56754
|
-
required: [
|
|
56755
|
-
'accessibility_type',
|
|
56756
|
-
'door_name',
|
|
56757
|
-
'door_type',
|
|
56758
|
-
'is_connected',
|
|
56759
|
-
],
|
|
56760
|
-
type: 'object',
|
|
56761
|
-
},
|
|
56762
|
-
salto_ks_metadata: {
|
|
56763
|
-
description:
|
|
56764
|
-
'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56765
|
-
properties: {
|
|
56766
|
-
battery_level: {
|
|
56767
|
-
description:
|
|
56768
|
-
'Battery level of the door access device.',
|
|
56769
|
-
type: 'string',
|
|
56770
|
-
},
|
|
56771
|
-
door_name: {
|
|
56772
|
-
description:
|
|
56773
|
-
'Name of the door in the Salto KS access system.',
|
|
56774
|
-
type: 'string',
|
|
56775
|
-
},
|
|
56776
|
-
intrusion_alarm: {
|
|
56777
|
-
description:
|
|
56778
|
-
'Indicates whether an intrusion alarm is active on the door.',
|
|
56779
|
-
type: 'boolean',
|
|
56780
|
-
},
|
|
56781
|
-
left_open_alarm: {
|
|
56782
|
-
description:
|
|
56783
|
-
'Indicates whether the door is left open.',
|
|
56784
|
-
type: 'boolean',
|
|
56785
|
-
},
|
|
56786
|
-
lock_type: {
|
|
56787
|
-
description:
|
|
56788
|
-
'Type of the lock in the Salto KS access system.',
|
|
56789
|
-
type: 'string',
|
|
56790
|
-
},
|
|
56791
|
-
locked_state: {
|
|
56792
|
-
description:
|
|
56793
|
-
'Locked state of the door in the Salto KS access system.',
|
|
56794
|
-
type: 'string',
|
|
56795
|
-
},
|
|
56796
|
-
online: {
|
|
56797
|
-
description:
|
|
56798
|
-
'Indicates whether the door access device is online.',
|
|
56799
|
-
type: 'boolean',
|
|
56800
|
-
},
|
|
56801
|
-
privacy_mode: {
|
|
56802
|
-
description:
|
|
56803
|
-
'Indicates whether privacy mode is enabled for the lock.',
|
|
56804
|
-
type: 'boolean',
|
|
56805
|
-
},
|
|
56806
|
-
},
|
|
56807
|
-
required: [
|
|
56808
|
-
'door_name',
|
|
56809
|
-
'locked_state',
|
|
56810
|
-
'lock_type',
|
|
56811
|
-
'battery_level',
|
|
56812
|
-
],
|
|
56813
|
-
type: 'object',
|
|
56814
|
-
},
|
|
56815
|
-
salto_space_metadata: {
|
|
56816
|
-
description:
|
|
56817
|
-
'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56818
|
-
properties: {
|
|
56819
|
-
door_description: {
|
|
56820
|
-
description:
|
|
56821
|
-
'Description of the door in the Salto Space access system.',
|
|
56822
|
-
type: 'string',
|
|
56823
|
-
},
|
|
56824
|
-
door_id: {
|
|
56825
|
-
description:
|
|
56826
|
-
'Door ID in the Salto Space access system.',
|
|
56827
|
-
type: 'string',
|
|
56828
|
-
},
|
|
56829
|
-
door_name: {
|
|
56830
|
-
description:
|
|
56831
|
-
'Name of the door in the Salto Space access system.',
|
|
56832
|
-
type: 'string',
|
|
56833
|
-
},
|
|
56834
|
-
ext_door_id: {
|
|
56835
|
-
deprecated: true,
|
|
56836
|
-
type: 'string',
|
|
56837
|
-
'x-deprecated': 'use door_id.',
|
|
56838
|
-
},
|
|
56839
|
-
room_description: {
|
|
56840
|
-
description:
|
|
56841
|
-
'Description of the room in the Salto Space access system.',
|
|
56842
|
-
type: 'string',
|
|
56843
|
-
},
|
|
56844
|
-
room_name: {
|
|
56845
|
-
description:
|
|
56846
|
-
'Name of the room in the Salto Space access system.',
|
|
56847
|
-
type: 'string',
|
|
56848
|
-
},
|
|
56849
|
-
},
|
|
56850
|
-
type: 'object',
|
|
56851
|
-
},
|
|
56852
|
-
space_ids: {
|
|
56853
|
-
items: { format: 'uuid', type: 'string' },
|
|
56854
|
-
type: 'array',
|
|
56855
|
-
},
|
|
56856
|
-
visionline_metadata: {
|
|
56857
|
-
description:
|
|
56858
|
-
'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
56859
|
-
properties: {
|
|
56860
|
-
door_category: {
|
|
56861
|
-
description:
|
|
56862
|
-
'Category of the door in the Visionline access system.',
|
|
56863
|
-
enum: [
|
|
56864
|
-
'entrance',
|
|
56865
|
-
'guest',
|
|
56866
|
-
'elevator reader',
|
|
56867
|
-
'common',
|
|
56868
|
-
'common (PMS)',
|
|
56869
|
-
],
|
|
56870
|
-
type: 'string',
|
|
56871
|
-
},
|
|
56872
|
-
door_name: {
|
|
56873
|
-
description:
|
|
56874
|
-
'Name of the door in the Visionline access system.',
|
|
56875
|
-
type: 'string',
|
|
56876
|
-
},
|
|
56877
|
-
profiles: {
|
|
56878
|
-
description:
|
|
56879
|
-
'Profile for the door in the Visionline access system.',
|
|
56880
|
-
items: {
|
|
56881
|
-
properties: {
|
|
56882
|
-
visionline_door_profile_id: {
|
|
56883
|
-
description:
|
|
56884
|
-
'Door profile ID in the Visionline access system.',
|
|
56885
|
-
type: 'string',
|
|
56886
|
-
},
|
|
56887
|
-
visionline_door_profile_type: {
|
|
56888
|
-
description:
|
|
56889
|
-
'Door profile type in the Visionline access system.',
|
|
56890
|
-
enum: ['BLE', 'commonDoor', 'touch'],
|
|
56891
|
-
type: 'string',
|
|
56892
|
-
},
|
|
56893
|
-
},
|
|
56894
|
-
required: [
|
|
56895
|
-
'visionline_door_profile_id',
|
|
56896
|
-
'visionline_door_profile_type',
|
|
56897
|
-
],
|
|
56898
|
-
type: 'object',
|
|
56899
|
-
},
|
|
56900
|
-
type: 'array',
|
|
56901
|
-
},
|
|
56902
|
-
},
|
|
56903
|
-
required: ['door_name', 'door_category'],
|
|
56904
|
-
type: 'object',
|
|
56905
|
-
},
|
|
56906
|
-
},
|
|
56907
|
-
required: [
|
|
56908
|
-
'acs_system_id',
|
|
56909
|
-
'acs_entrance_id',
|
|
56910
|
-
'created_at',
|
|
56911
|
-
'display_name',
|
|
56912
|
-
'connected_account_id',
|
|
56913
|
-
'errors',
|
|
56914
|
-
'space_ids',
|
|
56915
|
-
],
|
|
56916
|
-
type: 'object',
|
|
56917
|
-
'x-route-path': '/acs/entrances',
|
|
56918
|
-
},
|
|
56344
|
+
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
56919
56345
|
type: 'array',
|
|
56920
56346
|
},
|
|
56921
56347
|
acs_systems: {
|