@seamapi/types 1.263.0 → 1.264.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.
@@ -86,25 +86,165 @@ export interface Routes {
86
86
  status: 'pending'
87
87
  result: null
88
88
  error: null
89
- action_type: 'READ_CARD'
89
+ action_type: 'SCAN_CARD'
90
90
  }
91
91
  | {
92
92
  /** The ID of the action attempt. */
93
93
  action_attempt_id: string
94
94
  status: 'success'
95
95
  error: null
96
- action_type: 'READ_CARD'
96
+ action_type: 'SCAN_CARD'
97
97
  result: {
98
- /** A number or string that physically identifies this card. */
99
- card_number: string | null
100
- }
101
- }
102
- | {
103
- /** The ID of the action attempt. */
104
- action_attempt_id: string
105
- status: 'error'
106
- result: null
107
- action_type: 'READ_CARD'
98
+ /** Snapshot of the card data read from the physical encoder. */
99
+ acs_credential_on_encoder: {
100
+ /** Date and time the credential was created. */
101
+ created_at: string
102
+ is_issued: boolean | null
103
+ /** Date and time the credential will become useable. */
104
+ starts_at: string | null
105
+ /** Date and time the credential will stop being useable. */
106
+ ends_at: string | null
107
+ /** A number or string that physically identifies this card. */
108
+ card_number: string | null
109
+ visionline_metadata?:
110
+ | {
111
+ card_id: string
112
+ card_function_type: 'guest' | 'staff'
113
+ cancelled: boolean
114
+ discarded: boolean
115
+ expired: boolean
116
+ overwritten: boolean
117
+ overridden?: boolean | undefined
118
+ pending_auto_update: boolean
119
+ card_format: 'TLCode' | 'rfid48'
120
+ card_holder?: string | undefined
121
+ number_of_issued_cards: number
122
+ }
123
+ | undefined
124
+ }
125
+ /** Matching acs_credential currently encoded on this card. */
126
+ acs_credential_on_seam:
127
+ | (
128
+ | {
129
+ acs_credential_id: string
130
+ acs_user_id?: string | undefined
131
+ acs_credential_pool_id?: string | undefined
132
+ acs_system_id: string
133
+ parent_acs_credential_id?: string | undefined
134
+ display_name: string
135
+ code?: (string | undefined) | null
136
+ card_number?: (string | undefined) | null
137
+ is_issued?: boolean | undefined
138
+ issued_at?: (string | undefined) | null
139
+ access_method: 'code' | 'card' | 'mobile_key'
140
+ external_type?:
141
+ | (
142
+ | 'pti_card'
143
+ | 'brivo_credential'
144
+ | 'hid_credential'
145
+ | 'visionline_card'
146
+ | 'salto_ks_credential'
147
+ )
148
+ | undefined
149
+ external_type_display_name?: string | undefined
150
+ created_at: string
151
+ workspace_id: string
152
+ starts_at?: string | undefined
153
+ ends_at?: string | undefined
154
+ errors: Array<{
155
+ error_code: string
156
+ message: string
157
+ }>
158
+ warnings: Array<{
159
+ warning_code: string
160
+ message: string
161
+ }>
162
+ is_multi_phone_sync_credential?: boolean | undefined
163
+ is_latest_desired_state_synced_with_provider?:
164
+ | boolean
165
+ | undefined
166
+ latest_desired_state_synced_with_provider_at?:
167
+ | string
168
+ | undefined
169
+ visionline_metadata?:
170
+ | {
171
+ card_function_type: 'guest' | 'staff'
172
+ joiner_acs_credential_ids?: string[] | undefined
173
+ guest_acs_entrance_ids?: string[] | undefined
174
+ common_acs_entrance_ids?: string[] | undefined
175
+ is_valid?: boolean | undefined
176
+ auto_join?: boolean | undefined
177
+ card_id?: string | undefined
178
+ credential_id?: string | undefined
179
+ }
180
+ | undefined
181
+ is_managed: true
182
+ }
183
+ | {
184
+ acs_credential_id: string
185
+ acs_user_id?: string | undefined
186
+ acs_credential_pool_id?: string | undefined
187
+ acs_system_id: string
188
+ parent_acs_credential_id?: string | undefined
189
+ display_name: string
190
+ code?: (string | undefined) | null
191
+ card_number?: (string | undefined) | null
192
+ is_issued?: boolean | undefined
193
+ issued_at?: (string | undefined) | null
194
+ access_method: 'code' | 'card' | 'mobile_key'
195
+ external_type?:
196
+ | (
197
+ | 'pti_card'
198
+ | 'brivo_credential'
199
+ | 'hid_credential'
200
+ | 'visionline_card'
201
+ | 'salto_ks_credential'
202
+ )
203
+ | undefined
204
+ external_type_display_name?: string | undefined
205
+ created_at: string
206
+ workspace_id: string
207
+ starts_at?: string | undefined
208
+ ends_at?: string | undefined
209
+ errors: Array<{
210
+ error_code: string
211
+ message: string
212
+ }>
213
+ warnings: Array<{
214
+ warning_code: string
215
+ message: string
216
+ }>
217
+ is_multi_phone_sync_credential?: boolean | undefined
218
+ is_latest_desired_state_synced_with_provider?:
219
+ | boolean
220
+ | undefined
221
+ latest_desired_state_synced_with_provider_at?:
222
+ | string
223
+ | undefined
224
+ visionline_metadata?:
225
+ | {
226
+ card_function_type: 'guest' | 'staff'
227
+ joiner_acs_credential_ids?: string[] | undefined
228
+ guest_acs_entrance_ids?: string[] | undefined
229
+ common_acs_entrance_ids?: string[] | undefined
230
+ is_valid?: boolean | undefined
231
+ auto_join?: boolean | undefined
232
+ card_id?: string | undefined
233
+ credential_id?: string | undefined
234
+ }
235
+ | undefined
236
+ is_managed: false
237
+ }
238
+ )
239
+ | null
240
+ }
241
+ }
242
+ | {
243
+ /** The ID of the action attempt. */
244
+ action_attempt_id: string
245
+ status: 'error'
246
+ result: null
247
+ action_type: 'SCAN_CARD'
108
248
  error: {
109
249
  type: 'no_card_on_encoder'
110
250
  message: string
@@ -752,25 +892,165 @@ export interface Routes {
752
892
  status: 'pending'
753
893
  result: null
754
894
  error: null
755
- action_type: 'READ_CARD'
895
+ action_type: 'SCAN_CARD'
756
896
  }
757
897
  | {
758
898
  /** The ID of the action attempt. */
759
899
  action_attempt_id: string
760
900
  status: 'success'
761
901
  error: null
762
- action_type: 'READ_CARD'
902
+ action_type: 'SCAN_CARD'
763
903
  result: {
764
- /** A number or string that physically identifies this card. */
765
- card_number: string | null
766
- }
767
- }
768
- | {
769
- /** The ID of the action attempt. */
770
- action_attempt_id: string
771
- status: 'error'
772
- result: null
773
- action_type: 'READ_CARD'
904
+ /** Snapshot of the card data read from the physical encoder. */
905
+ acs_credential_on_encoder: {
906
+ /** Date and time the credential was created. */
907
+ created_at: string
908
+ is_issued: boolean | null
909
+ /** Date and time the credential will become useable. */
910
+ starts_at: string | null
911
+ /** Date and time the credential will stop being useable. */
912
+ ends_at: string | null
913
+ /** A number or string that physically identifies this card. */
914
+ card_number: string | null
915
+ visionline_metadata?:
916
+ | {
917
+ card_id: string
918
+ card_function_type: 'guest' | 'staff'
919
+ cancelled: boolean
920
+ discarded: boolean
921
+ expired: boolean
922
+ overwritten: boolean
923
+ overridden?: boolean | undefined
924
+ pending_auto_update: boolean
925
+ card_format: 'TLCode' | 'rfid48'
926
+ card_holder?: string | undefined
927
+ number_of_issued_cards: number
928
+ }
929
+ | undefined
930
+ }
931
+ /** Matching acs_credential currently encoded on this card. */
932
+ acs_credential_on_seam:
933
+ | (
934
+ | {
935
+ acs_credential_id: string
936
+ acs_user_id?: string | undefined
937
+ acs_credential_pool_id?: string | undefined
938
+ acs_system_id: string
939
+ parent_acs_credential_id?: string | undefined
940
+ display_name: string
941
+ code?: (string | undefined) | null
942
+ card_number?: (string | undefined) | null
943
+ is_issued?: boolean | undefined
944
+ issued_at?: (string | undefined) | null
945
+ access_method: 'code' | 'card' | 'mobile_key'
946
+ external_type?:
947
+ | (
948
+ | 'pti_card'
949
+ | 'brivo_credential'
950
+ | 'hid_credential'
951
+ | 'visionline_card'
952
+ | 'salto_ks_credential'
953
+ )
954
+ | undefined
955
+ external_type_display_name?: string | undefined
956
+ created_at: string
957
+ workspace_id: string
958
+ starts_at?: string | undefined
959
+ ends_at?: string | undefined
960
+ errors: Array<{
961
+ error_code: string
962
+ message: string
963
+ }>
964
+ warnings: Array<{
965
+ warning_code: string
966
+ message: string
967
+ }>
968
+ is_multi_phone_sync_credential?: boolean | undefined
969
+ is_latest_desired_state_synced_with_provider?:
970
+ | boolean
971
+ | undefined
972
+ latest_desired_state_synced_with_provider_at?:
973
+ | string
974
+ | undefined
975
+ visionline_metadata?:
976
+ | {
977
+ card_function_type: 'guest' | 'staff'
978
+ joiner_acs_credential_ids?: string[] | undefined
979
+ guest_acs_entrance_ids?: string[] | undefined
980
+ common_acs_entrance_ids?: string[] | undefined
981
+ is_valid?: boolean | undefined
982
+ auto_join?: boolean | undefined
983
+ card_id?: string | undefined
984
+ credential_id?: string | undefined
985
+ }
986
+ | undefined
987
+ is_managed: true
988
+ }
989
+ | {
990
+ acs_credential_id: string
991
+ acs_user_id?: string | undefined
992
+ acs_credential_pool_id?: string | undefined
993
+ acs_system_id: string
994
+ parent_acs_credential_id?: string | undefined
995
+ display_name: string
996
+ code?: (string | undefined) | null
997
+ card_number?: (string | undefined) | null
998
+ is_issued?: boolean | undefined
999
+ issued_at?: (string | undefined) | null
1000
+ access_method: 'code' | 'card' | 'mobile_key'
1001
+ external_type?:
1002
+ | (
1003
+ | 'pti_card'
1004
+ | 'brivo_credential'
1005
+ | 'hid_credential'
1006
+ | 'visionline_card'
1007
+ | 'salto_ks_credential'
1008
+ )
1009
+ | undefined
1010
+ external_type_display_name?: string | undefined
1011
+ created_at: string
1012
+ workspace_id: string
1013
+ starts_at?: string | undefined
1014
+ ends_at?: string | undefined
1015
+ errors: Array<{
1016
+ error_code: string
1017
+ message: string
1018
+ }>
1019
+ warnings: Array<{
1020
+ warning_code: string
1021
+ message: string
1022
+ }>
1023
+ is_multi_phone_sync_credential?: boolean | undefined
1024
+ is_latest_desired_state_synced_with_provider?:
1025
+ | boolean
1026
+ | undefined
1027
+ latest_desired_state_synced_with_provider_at?:
1028
+ | string
1029
+ | undefined
1030
+ visionline_metadata?:
1031
+ | {
1032
+ card_function_type: 'guest' | 'staff'
1033
+ joiner_acs_credential_ids?: string[] | undefined
1034
+ guest_acs_entrance_ids?: string[] | undefined
1035
+ common_acs_entrance_ids?: string[] | undefined
1036
+ is_valid?: boolean | undefined
1037
+ auto_join?: boolean | undefined
1038
+ card_id?: string | undefined
1039
+ credential_id?: string | undefined
1040
+ }
1041
+ | undefined
1042
+ is_managed: false
1043
+ }
1044
+ )
1045
+ | null
1046
+ }
1047
+ }
1048
+ | {
1049
+ /** The ID of the action attempt. */
1050
+ action_attempt_id: string
1051
+ status: 'error'
1052
+ result: null
1053
+ action_type: 'SCAN_CARD'
774
1054
  error: {
775
1055
  type: 'no_card_on_encoder'
776
1056
  message: string
@@ -1583,25 +1863,165 @@ export interface Routes {
1583
1863
  status: 'pending'
1584
1864
  result: null
1585
1865
  error: null
1586
- action_type: 'READ_CARD'
1866
+ action_type: 'SCAN_CARD'
1587
1867
  }
1588
1868
  | {
1589
1869
  /** The ID of the action attempt. */
1590
1870
  action_attempt_id: string
1591
1871
  status: 'success'
1592
1872
  error: null
1593
- action_type: 'READ_CARD'
1873
+ action_type: 'SCAN_CARD'
1594
1874
  result: {
1595
- /** A number or string that physically identifies this card. */
1596
- card_number: string | null
1597
- }
1598
- }
1599
- | {
1600
- /** The ID of the action attempt. */
1601
- action_attempt_id: string
1602
- status: 'error'
1603
- result: null
1604
- action_type: 'READ_CARD'
1875
+ /** Snapshot of the card data read from the physical encoder. */
1876
+ acs_credential_on_encoder: {
1877
+ /** Date and time the credential was created. */
1878
+ created_at: string
1879
+ is_issued: boolean | null
1880
+ /** Date and time the credential will become useable. */
1881
+ starts_at: string | null
1882
+ /** Date and time the credential will stop being useable. */
1883
+ ends_at: string | null
1884
+ /** A number or string that physically identifies this card. */
1885
+ card_number: string | null
1886
+ visionline_metadata?:
1887
+ | {
1888
+ card_id: string
1889
+ card_function_type: 'guest' | 'staff'
1890
+ cancelled: boolean
1891
+ discarded: boolean
1892
+ expired: boolean
1893
+ overwritten: boolean
1894
+ overridden?: boolean | undefined
1895
+ pending_auto_update: boolean
1896
+ card_format: 'TLCode' | 'rfid48'
1897
+ card_holder?: string | undefined
1898
+ number_of_issued_cards: number
1899
+ }
1900
+ | undefined
1901
+ }
1902
+ /** Matching acs_credential currently encoded on this card. */
1903
+ acs_credential_on_seam:
1904
+ | (
1905
+ | {
1906
+ acs_credential_id: string
1907
+ acs_user_id?: string | undefined
1908
+ acs_credential_pool_id?: string | undefined
1909
+ acs_system_id: string
1910
+ parent_acs_credential_id?: string | undefined
1911
+ display_name: string
1912
+ code?: (string | undefined) | null
1913
+ card_number?: (string | undefined) | null
1914
+ is_issued?: boolean | undefined
1915
+ issued_at?: (string | undefined) | null
1916
+ access_method: 'code' | 'card' | 'mobile_key'
1917
+ external_type?:
1918
+ | (
1919
+ | 'pti_card'
1920
+ | 'brivo_credential'
1921
+ | 'hid_credential'
1922
+ | 'visionline_card'
1923
+ | 'salto_ks_credential'
1924
+ )
1925
+ | undefined
1926
+ external_type_display_name?: string | undefined
1927
+ created_at: string
1928
+ workspace_id: string
1929
+ starts_at?: string | undefined
1930
+ ends_at?: string | undefined
1931
+ errors: Array<{
1932
+ error_code: string
1933
+ message: string
1934
+ }>
1935
+ warnings: Array<{
1936
+ warning_code: string
1937
+ message: string
1938
+ }>
1939
+ is_multi_phone_sync_credential?: boolean | undefined
1940
+ is_latest_desired_state_synced_with_provider?:
1941
+ | boolean
1942
+ | undefined
1943
+ latest_desired_state_synced_with_provider_at?:
1944
+ | string
1945
+ | undefined
1946
+ visionline_metadata?:
1947
+ | {
1948
+ card_function_type: 'guest' | 'staff'
1949
+ joiner_acs_credential_ids?: string[] | undefined
1950
+ guest_acs_entrance_ids?: string[] | undefined
1951
+ common_acs_entrance_ids?: string[] | undefined
1952
+ is_valid?: boolean | undefined
1953
+ auto_join?: boolean | undefined
1954
+ card_id?: string | undefined
1955
+ credential_id?: string | undefined
1956
+ }
1957
+ | undefined
1958
+ is_managed: true
1959
+ }
1960
+ | {
1961
+ acs_credential_id: string
1962
+ acs_user_id?: string | undefined
1963
+ acs_credential_pool_id?: string | undefined
1964
+ acs_system_id: string
1965
+ parent_acs_credential_id?: string | undefined
1966
+ display_name: string
1967
+ code?: (string | undefined) | null
1968
+ card_number?: (string | undefined) | null
1969
+ is_issued?: boolean | undefined
1970
+ issued_at?: (string | undefined) | null
1971
+ access_method: 'code' | 'card' | 'mobile_key'
1972
+ external_type?:
1973
+ | (
1974
+ | 'pti_card'
1975
+ | 'brivo_credential'
1976
+ | 'hid_credential'
1977
+ | 'visionline_card'
1978
+ | 'salto_ks_credential'
1979
+ )
1980
+ | undefined
1981
+ external_type_display_name?: string | undefined
1982
+ created_at: string
1983
+ workspace_id: string
1984
+ starts_at?: string | undefined
1985
+ ends_at?: string | undefined
1986
+ errors: Array<{
1987
+ error_code: string
1988
+ message: string
1989
+ }>
1990
+ warnings: Array<{
1991
+ warning_code: string
1992
+ message: string
1993
+ }>
1994
+ is_multi_phone_sync_credential?: boolean | undefined
1995
+ is_latest_desired_state_synced_with_provider?:
1996
+ | boolean
1997
+ | undefined
1998
+ latest_desired_state_synced_with_provider_at?:
1999
+ | string
2000
+ | undefined
2001
+ visionline_metadata?:
2002
+ | {
2003
+ card_function_type: 'guest' | 'staff'
2004
+ joiner_acs_credential_ids?: string[] | undefined
2005
+ guest_acs_entrance_ids?: string[] | undefined
2006
+ common_acs_entrance_ids?: string[] | undefined
2007
+ is_valid?: boolean | undefined
2008
+ auto_join?: boolean | undefined
2009
+ card_id?: string | undefined
2010
+ credential_id?: string | undefined
2011
+ }
2012
+ | undefined
2013
+ is_managed: false
2014
+ }
2015
+ )
2016
+ | null
2017
+ }
2018
+ }
2019
+ | {
2020
+ /** The ID of the action attempt. */
2021
+ action_attempt_id: string
2022
+ status: 'error'
2023
+ result: null
2024
+ action_type: 'SCAN_CARD'
1605
2025
  error: {
1606
2026
  type: 'no_card_on_encoder'
1607
2027
  message: string
@@ -2236,25 +2656,165 @@ export interface Routes {
2236
2656
  status: 'pending'
2237
2657
  result: null
2238
2658
  error: null
2239
- action_type: 'READ_CARD'
2659
+ action_type: 'SCAN_CARD'
2240
2660
  }
2241
2661
  | {
2242
2662
  /** The ID of the action attempt. */
2243
2663
  action_attempt_id: string
2244
2664
  status: 'success'
2245
2665
  error: null
2246
- action_type: 'READ_CARD'
2666
+ action_type: 'SCAN_CARD'
2247
2667
  result: {
2248
- /** A number or string that physically identifies this card. */
2249
- card_number: string | null
2250
- }
2251
- }
2252
- | {
2253
- /** The ID of the action attempt. */
2254
- action_attempt_id: string
2255
- status: 'error'
2256
- result: null
2257
- action_type: 'READ_CARD'
2668
+ /** Snapshot of the card data read from the physical encoder. */
2669
+ acs_credential_on_encoder: {
2670
+ /** Date and time the credential was created. */
2671
+ created_at: string
2672
+ is_issued: boolean | null
2673
+ /** Date and time the credential will become useable. */
2674
+ starts_at: string | null
2675
+ /** Date and time the credential will stop being useable. */
2676
+ ends_at: string | null
2677
+ /** A number or string that physically identifies this card. */
2678
+ card_number: string | null
2679
+ visionline_metadata?:
2680
+ | {
2681
+ card_id: string
2682
+ card_function_type: 'guest' | 'staff'
2683
+ cancelled: boolean
2684
+ discarded: boolean
2685
+ expired: boolean
2686
+ overwritten: boolean
2687
+ overridden?: boolean | undefined
2688
+ pending_auto_update: boolean
2689
+ card_format: 'TLCode' | 'rfid48'
2690
+ card_holder?: string | undefined
2691
+ number_of_issued_cards: number
2692
+ }
2693
+ | undefined
2694
+ }
2695
+ /** Matching acs_credential currently encoded on this card. */
2696
+ acs_credential_on_seam:
2697
+ | (
2698
+ | {
2699
+ acs_credential_id: string
2700
+ acs_user_id?: string | undefined
2701
+ acs_credential_pool_id?: string | undefined
2702
+ acs_system_id: string
2703
+ parent_acs_credential_id?: string | undefined
2704
+ display_name: string
2705
+ code?: (string | undefined) | null
2706
+ card_number?: (string | undefined) | null
2707
+ is_issued?: boolean | undefined
2708
+ issued_at?: (string | undefined) | null
2709
+ access_method: 'code' | 'card' | 'mobile_key'
2710
+ external_type?:
2711
+ | (
2712
+ | 'pti_card'
2713
+ | 'brivo_credential'
2714
+ | 'hid_credential'
2715
+ | 'visionline_card'
2716
+ | 'salto_ks_credential'
2717
+ )
2718
+ | undefined
2719
+ external_type_display_name?: string | undefined
2720
+ created_at: string
2721
+ workspace_id: string
2722
+ starts_at?: string | undefined
2723
+ ends_at?: string | undefined
2724
+ errors: Array<{
2725
+ error_code: string
2726
+ message: string
2727
+ }>
2728
+ warnings: Array<{
2729
+ warning_code: string
2730
+ message: string
2731
+ }>
2732
+ is_multi_phone_sync_credential?: boolean | undefined
2733
+ is_latest_desired_state_synced_with_provider?:
2734
+ | boolean
2735
+ | undefined
2736
+ latest_desired_state_synced_with_provider_at?:
2737
+ | string
2738
+ | undefined
2739
+ visionline_metadata?:
2740
+ | {
2741
+ card_function_type: 'guest' | 'staff'
2742
+ joiner_acs_credential_ids?: string[] | undefined
2743
+ guest_acs_entrance_ids?: string[] | undefined
2744
+ common_acs_entrance_ids?: string[] | undefined
2745
+ is_valid?: boolean | undefined
2746
+ auto_join?: boolean | undefined
2747
+ card_id?: string | undefined
2748
+ credential_id?: string | undefined
2749
+ }
2750
+ | undefined
2751
+ is_managed: true
2752
+ }
2753
+ | {
2754
+ acs_credential_id: string
2755
+ acs_user_id?: string | undefined
2756
+ acs_credential_pool_id?: string | undefined
2757
+ acs_system_id: string
2758
+ parent_acs_credential_id?: string | undefined
2759
+ display_name: string
2760
+ code?: (string | undefined) | null
2761
+ card_number?: (string | undefined) | null
2762
+ is_issued?: boolean | undefined
2763
+ issued_at?: (string | undefined) | null
2764
+ access_method: 'code' | 'card' | 'mobile_key'
2765
+ external_type?:
2766
+ | (
2767
+ | 'pti_card'
2768
+ | 'brivo_credential'
2769
+ | 'hid_credential'
2770
+ | 'visionline_card'
2771
+ | 'salto_ks_credential'
2772
+ )
2773
+ | undefined
2774
+ external_type_display_name?: string | undefined
2775
+ created_at: string
2776
+ workspace_id: string
2777
+ starts_at?: string | undefined
2778
+ ends_at?: string | undefined
2779
+ errors: Array<{
2780
+ error_code: string
2781
+ message: string
2782
+ }>
2783
+ warnings: Array<{
2784
+ warning_code: string
2785
+ message: string
2786
+ }>
2787
+ is_multi_phone_sync_credential?: boolean | undefined
2788
+ is_latest_desired_state_synced_with_provider?:
2789
+ | boolean
2790
+ | undefined
2791
+ latest_desired_state_synced_with_provider_at?:
2792
+ | string
2793
+ | undefined
2794
+ visionline_metadata?:
2795
+ | {
2796
+ card_function_type: 'guest' | 'staff'
2797
+ joiner_acs_credential_ids?: string[] | undefined
2798
+ guest_acs_entrance_ids?: string[] | undefined
2799
+ common_acs_entrance_ids?: string[] | undefined
2800
+ is_valid?: boolean | undefined
2801
+ auto_join?: boolean | undefined
2802
+ card_id?: string | undefined
2803
+ credential_id?: string | undefined
2804
+ }
2805
+ | undefined
2806
+ is_managed: false
2807
+ }
2808
+ )
2809
+ | null
2810
+ }
2811
+ }
2812
+ | {
2813
+ /** The ID of the action attempt. */
2814
+ action_attempt_id: string
2815
+ status: 'error'
2816
+ result: null
2817
+ action_type: 'SCAN_CARD'
2258
2818
  error: {
2259
2819
  type: 'no_card_on_encoder'
2260
2820
  message: string
@@ -3797,25 +4357,165 @@ export interface Routes {
3797
4357
  status: 'pending'
3798
4358
  result: null
3799
4359
  error: null
3800
- action_type: 'READ_CARD'
4360
+ action_type: 'SCAN_CARD'
3801
4361
  }
3802
4362
  | {
3803
4363
  /** The ID of the action attempt. */
3804
4364
  action_attempt_id: string
3805
4365
  status: 'success'
3806
4366
  error: null
3807
- action_type: 'READ_CARD'
4367
+ action_type: 'SCAN_CARD'
3808
4368
  result: {
3809
- /** A number or string that physically identifies this card. */
3810
- card_number: string | null
3811
- }
3812
- }
3813
- | {
3814
- /** The ID of the action attempt. */
3815
- action_attempt_id: string
3816
- status: 'error'
3817
- result: null
3818
- action_type: 'READ_CARD'
4369
+ /** Snapshot of the card data read from the physical encoder. */
4370
+ acs_credential_on_encoder: {
4371
+ /** Date and time the credential was created. */
4372
+ created_at: string
4373
+ is_issued: boolean | null
4374
+ /** Date and time the credential will become useable. */
4375
+ starts_at: string | null
4376
+ /** Date and time the credential will stop being useable. */
4377
+ ends_at: string | null
4378
+ /** A number or string that physically identifies this card. */
4379
+ card_number: string | null
4380
+ visionline_metadata?:
4381
+ | {
4382
+ card_id: string
4383
+ card_function_type: 'guest' | 'staff'
4384
+ cancelled: boolean
4385
+ discarded: boolean
4386
+ expired: boolean
4387
+ overwritten: boolean
4388
+ overridden?: boolean | undefined
4389
+ pending_auto_update: boolean
4390
+ card_format: 'TLCode' | 'rfid48'
4391
+ card_holder?: string | undefined
4392
+ number_of_issued_cards: number
4393
+ }
4394
+ | undefined
4395
+ }
4396
+ /** Matching acs_credential currently encoded on this card. */
4397
+ acs_credential_on_seam:
4398
+ | (
4399
+ | {
4400
+ acs_credential_id: string
4401
+ acs_user_id?: string | undefined
4402
+ acs_credential_pool_id?: string | undefined
4403
+ acs_system_id: string
4404
+ parent_acs_credential_id?: string | undefined
4405
+ display_name: string
4406
+ code?: (string | undefined) | null
4407
+ card_number?: (string | undefined) | null
4408
+ is_issued?: boolean | undefined
4409
+ issued_at?: (string | undefined) | null
4410
+ access_method: 'code' | 'card' | 'mobile_key'
4411
+ external_type?:
4412
+ | (
4413
+ | 'pti_card'
4414
+ | 'brivo_credential'
4415
+ | 'hid_credential'
4416
+ | 'visionline_card'
4417
+ | 'salto_ks_credential'
4418
+ )
4419
+ | undefined
4420
+ external_type_display_name?: string | undefined
4421
+ created_at: string
4422
+ workspace_id: string
4423
+ starts_at?: string | undefined
4424
+ ends_at?: string | undefined
4425
+ errors: Array<{
4426
+ error_code: string
4427
+ message: string
4428
+ }>
4429
+ warnings: Array<{
4430
+ warning_code: string
4431
+ message: string
4432
+ }>
4433
+ is_multi_phone_sync_credential?: boolean | undefined
4434
+ is_latest_desired_state_synced_with_provider?:
4435
+ | boolean
4436
+ | undefined
4437
+ latest_desired_state_synced_with_provider_at?:
4438
+ | string
4439
+ | undefined
4440
+ visionline_metadata?:
4441
+ | {
4442
+ card_function_type: 'guest' | 'staff'
4443
+ joiner_acs_credential_ids?: string[] | undefined
4444
+ guest_acs_entrance_ids?: string[] | undefined
4445
+ common_acs_entrance_ids?: string[] | undefined
4446
+ is_valid?: boolean | undefined
4447
+ auto_join?: boolean | undefined
4448
+ card_id?: string | undefined
4449
+ credential_id?: string | undefined
4450
+ }
4451
+ | undefined
4452
+ is_managed: true
4453
+ }
4454
+ | {
4455
+ acs_credential_id: string
4456
+ acs_user_id?: string | undefined
4457
+ acs_credential_pool_id?: string | undefined
4458
+ acs_system_id: string
4459
+ parent_acs_credential_id?: string | undefined
4460
+ display_name: string
4461
+ code?: (string | undefined) | null
4462
+ card_number?: (string | undefined) | null
4463
+ is_issued?: boolean | undefined
4464
+ issued_at?: (string | undefined) | null
4465
+ access_method: 'code' | 'card' | 'mobile_key'
4466
+ external_type?:
4467
+ | (
4468
+ | 'pti_card'
4469
+ | 'brivo_credential'
4470
+ | 'hid_credential'
4471
+ | 'visionline_card'
4472
+ | 'salto_ks_credential'
4473
+ )
4474
+ | undefined
4475
+ external_type_display_name?: string | undefined
4476
+ created_at: string
4477
+ workspace_id: string
4478
+ starts_at?: string | undefined
4479
+ ends_at?: string | undefined
4480
+ errors: Array<{
4481
+ error_code: string
4482
+ message: string
4483
+ }>
4484
+ warnings: Array<{
4485
+ warning_code: string
4486
+ message: string
4487
+ }>
4488
+ is_multi_phone_sync_credential?: boolean | undefined
4489
+ is_latest_desired_state_synced_with_provider?:
4490
+ | boolean
4491
+ | undefined
4492
+ latest_desired_state_synced_with_provider_at?:
4493
+ | string
4494
+ | undefined
4495
+ visionline_metadata?:
4496
+ | {
4497
+ card_function_type: 'guest' | 'staff'
4498
+ joiner_acs_credential_ids?: string[] | undefined
4499
+ guest_acs_entrance_ids?: string[] | undefined
4500
+ common_acs_entrance_ids?: string[] | undefined
4501
+ is_valid?: boolean | undefined
4502
+ auto_join?: boolean | undefined
4503
+ card_id?: string | undefined
4504
+ credential_id?: string | undefined
4505
+ }
4506
+ | undefined
4507
+ is_managed: false
4508
+ }
4509
+ )
4510
+ | null
4511
+ }
4512
+ }
4513
+ | {
4514
+ /** The ID of the action attempt. */
4515
+ action_attempt_id: string
4516
+ status: 'error'
4517
+ result: null
4518
+ action_type: 'SCAN_CARD'
3819
4519
  error: {
3820
4520
  type: 'no_card_on_encoder'
3821
4521
  message: string
@@ -4869,8 +5569,8 @@ export interface Routes {
4869
5569
  }>
4870
5570
  }
4871
5571
  }
4872
- '/acs/encoders/read_card': {
4873
- route: '/acs/encoders/read_card'
5572
+ '/acs/encoders/scan_card': {
5573
+ route: '/acs/encoders/scan_card'
4874
5574
  method: 'POST'
4875
5575
  queryParams: {}
4876
5576
  jsonBody: {}
@@ -4946,25 +5646,165 @@ export interface Routes {
4946
5646
  status: 'pending'
4947
5647
  result: null
4948
5648
  error: null
4949
- action_type: 'READ_CARD'
5649
+ action_type: 'SCAN_CARD'
4950
5650
  }
4951
5651
  | {
4952
5652
  /** The ID of the action attempt. */
4953
5653
  action_attempt_id: string
4954
5654
  status: 'success'
4955
5655
  error: null
4956
- action_type: 'READ_CARD'
5656
+ action_type: 'SCAN_CARD'
4957
5657
  result: {
4958
- /** A number or string that physically identifies this card. */
4959
- card_number: string | null
4960
- }
4961
- }
4962
- | {
4963
- /** The ID of the action attempt. */
4964
- action_attempt_id: string
4965
- status: 'error'
4966
- result: null
4967
- action_type: 'READ_CARD'
5658
+ /** Snapshot of the card data read from the physical encoder. */
5659
+ acs_credential_on_encoder: {
5660
+ /** Date and time the credential was created. */
5661
+ created_at: string
5662
+ is_issued: boolean | null
5663
+ /** Date and time the credential will become useable. */
5664
+ starts_at: string | null
5665
+ /** Date and time the credential will stop being useable. */
5666
+ ends_at: string | null
5667
+ /** A number or string that physically identifies this card. */
5668
+ card_number: string | null
5669
+ visionline_metadata?:
5670
+ | {
5671
+ card_id: string
5672
+ card_function_type: 'guest' | 'staff'
5673
+ cancelled: boolean
5674
+ discarded: boolean
5675
+ expired: boolean
5676
+ overwritten: boolean
5677
+ overridden?: boolean | undefined
5678
+ pending_auto_update: boolean
5679
+ card_format: 'TLCode' | 'rfid48'
5680
+ card_holder?: string | undefined
5681
+ number_of_issued_cards: number
5682
+ }
5683
+ | undefined
5684
+ }
5685
+ /** Matching acs_credential currently encoded on this card. */
5686
+ acs_credential_on_seam:
5687
+ | (
5688
+ | {
5689
+ acs_credential_id: string
5690
+ acs_user_id?: string | undefined
5691
+ acs_credential_pool_id?: string | undefined
5692
+ acs_system_id: string
5693
+ parent_acs_credential_id?: string | undefined
5694
+ display_name: string
5695
+ code?: (string | undefined) | null
5696
+ card_number?: (string | undefined) | null
5697
+ is_issued?: boolean | undefined
5698
+ issued_at?: (string | undefined) | null
5699
+ access_method: 'code' | 'card' | 'mobile_key'
5700
+ external_type?:
5701
+ | (
5702
+ | 'pti_card'
5703
+ | 'brivo_credential'
5704
+ | 'hid_credential'
5705
+ | 'visionline_card'
5706
+ | 'salto_ks_credential'
5707
+ )
5708
+ | undefined
5709
+ external_type_display_name?: string | undefined
5710
+ created_at: string
5711
+ workspace_id: string
5712
+ starts_at?: string | undefined
5713
+ ends_at?: string | undefined
5714
+ errors: Array<{
5715
+ error_code: string
5716
+ message: string
5717
+ }>
5718
+ warnings: Array<{
5719
+ warning_code: string
5720
+ message: string
5721
+ }>
5722
+ is_multi_phone_sync_credential?: boolean | undefined
5723
+ is_latest_desired_state_synced_with_provider?:
5724
+ | boolean
5725
+ | undefined
5726
+ latest_desired_state_synced_with_provider_at?:
5727
+ | string
5728
+ | undefined
5729
+ visionline_metadata?:
5730
+ | {
5731
+ card_function_type: 'guest' | 'staff'
5732
+ joiner_acs_credential_ids?: string[] | undefined
5733
+ guest_acs_entrance_ids?: string[] | undefined
5734
+ common_acs_entrance_ids?: string[] | undefined
5735
+ is_valid?: boolean | undefined
5736
+ auto_join?: boolean | undefined
5737
+ card_id?: string | undefined
5738
+ credential_id?: string | undefined
5739
+ }
5740
+ | undefined
5741
+ is_managed: true
5742
+ }
5743
+ | {
5744
+ acs_credential_id: string
5745
+ acs_user_id?: string | undefined
5746
+ acs_credential_pool_id?: string | undefined
5747
+ acs_system_id: string
5748
+ parent_acs_credential_id?: string | undefined
5749
+ display_name: string
5750
+ code?: (string | undefined) | null
5751
+ card_number?: (string | undefined) | null
5752
+ is_issued?: boolean | undefined
5753
+ issued_at?: (string | undefined) | null
5754
+ access_method: 'code' | 'card' | 'mobile_key'
5755
+ external_type?:
5756
+ | (
5757
+ | 'pti_card'
5758
+ | 'brivo_credential'
5759
+ | 'hid_credential'
5760
+ | 'visionline_card'
5761
+ | 'salto_ks_credential'
5762
+ )
5763
+ | undefined
5764
+ external_type_display_name?: string | undefined
5765
+ created_at: string
5766
+ workspace_id: string
5767
+ starts_at?: string | undefined
5768
+ ends_at?: string | undefined
5769
+ errors: Array<{
5770
+ error_code: string
5771
+ message: string
5772
+ }>
5773
+ warnings: Array<{
5774
+ warning_code: string
5775
+ message: string
5776
+ }>
5777
+ is_multi_phone_sync_credential?: boolean | undefined
5778
+ is_latest_desired_state_synced_with_provider?:
5779
+ | boolean
5780
+ | undefined
5781
+ latest_desired_state_synced_with_provider_at?:
5782
+ | string
5783
+ | undefined
5784
+ visionline_metadata?:
5785
+ | {
5786
+ card_function_type: 'guest' | 'staff'
5787
+ joiner_acs_credential_ids?: string[] | undefined
5788
+ guest_acs_entrance_ids?: string[] | undefined
5789
+ common_acs_entrance_ids?: string[] | undefined
5790
+ is_valid?: boolean | undefined
5791
+ auto_join?: boolean | undefined
5792
+ card_id?: string | undefined
5793
+ credential_id?: string | undefined
5794
+ }
5795
+ | undefined
5796
+ is_managed: false
5797
+ }
5798
+ )
5799
+ | null
5800
+ }
5801
+ }
5802
+ | {
5803
+ /** The ID of the action attempt. */
5804
+ action_attempt_id: string
5805
+ status: 'error'
5806
+ result: null
5807
+ action_type: 'SCAN_CARD'
4968
5808
  error: {
4969
5809
  type: 'no_card_on_encoder'
4970
5810
  message: string
@@ -6849,25 +7689,165 @@ export interface Routes {
6849
7689
  status: 'pending'
6850
7690
  result: null
6851
7691
  error: null
6852
- action_type: 'READ_CARD'
7692
+ action_type: 'SCAN_CARD'
6853
7693
  }
6854
7694
  | {
6855
7695
  /** The ID of the action attempt. */
6856
7696
  action_attempt_id: string
6857
7697
  status: 'success'
6858
7698
  error: null
6859
- action_type: 'READ_CARD'
7699
+ action_type: 'SCAN_CARD'
6860
7700
  result: {
6861
- /** A number or string that physically identifies this card. */
6862
- card_number: string | null
6863
- }
6864
- }
6865
- | {
6866
- /** The ID of the action attempt. */
6867
- action_attempt_id: string
6868
- status: 'error'
6869
- result: null
6870
- action_type: 'READ_CARD'
7701
+ /** Snapshot of the card data read from the physical encoder. */
7702
+ acs_credential_on_encoder: {
7703
+ /** Date and time the credential was created. */
7704
+ created_at: string
7705
+ is_issued: boolean | null
7706
+ /** Date and time the credential will become useable. */
7707
+ starts_at: string | null
7708
+ /** Date and time the credential will stop being useable. */
7709
+ ends_at: string | null
7710
+ /** A number or string that physically identifies this card. */
7711
+ card_number: string | null
7712
+ visionline_metadata?:
7713
+ | {
7714
+ card_id: string
7715
+ card_function_type: 'guest' | 'staff'
7716
+ cancelled: boolean
7717
+ discarded: boolean
7718
+ expired: boolean
7719
+ overwritten: boolean
7720
+ overridden?: boolean | undefined
7721
+ pending_auto_update: boolean
7722
+ card_format: 'TLCode' | 'rfid48'
7723
+ card_holder?: string | undefined
7724
+ number_of_issued_cards: number
7725
+ }
7726
+ | undefined
7727
+ }
7728
+ /** Matching acs_credential currently encoded on this card. */
7729
+ acs_credential_on_seam:
7730
+ | (
7731
+ | {
7732
+ acs_credential_id: string
7733
+ acs_user_id?: string | undefined
7734
+ acs_credential_pool_id?: string | undefined
7735
+ acs_system_id: string
7736
+ parent_acs_credential_id?: string | undefined
7737
+ display_name: string
7738
+ code?: (string | undefined) | null
7739
+ card_number?: (string | undefined) | null
7740
+ is_issued?: boolean | undefined
7741
+ issued_at?: (string | undefined) | null
7742
+ access_method: 'code' | 'card' | 'mobile_key'
7743
+ external_type?:
7744
+ | (
7745
+ | 'pti_card'
7746
+ | 'brivo_credential'
7747
+ | 'hid_credential'
7748
+ | 'visionline_card'
7749
+ | 'salto_ks_credential'
7750
+ )
7751
+ | undefined
7752
+ external_type_display_name?: string | undefined
7753
+ created_at: string
7754
+ workspace_id: string
7755
+ starts_at?: string | undefined
7756
+ ends_at?: string | undefined
7757
+ errors: Array<{
7758
+ error_code: string
7759
+ message: string
7760
+ }>
7761
+ warnings: Array<{
7762
+ warning_code: string
7763
+ message: string
7764
+ }>
7765
+ is_multi_phone_sync_credential?: boolean | undefined
7766
+ is_latest_desired_state_synced_with_provider?:
7767
+ | boolean
7768
+ | undefined
7769
+ latest_desired_state_synced_with_provider_at?:
7770
+ | string
7771
+ | undefined
7772
+ visionline_metadata?:
7773
+ | {
7774
+ card_function_type: 'guest' | 'staff'
7775
+ joiner_acs_credential_ids?: string[] | undefined
7776
+ guest_acs_entrance_ids?: string[] | undefined
7777
+ common_acs_entrance_ids?: string[] | undefined
7778
+ is_valid?: boolean | undefined
7779
+ auto_join?: boolean | undefined
7780
+ card_id?: string | undefined
7781
+ credential_id?: string | undefined
7782
+ }
7783
+ | undefined
7784
+ is_managed: true
7785
+ }
7786
+ | {
7787
+ acs_credential_id: string
7788
+ acs_user_id?: string | undefined
7789
+ acs_credential_pool_id?: string | undefined
7790
+ acs_system_id: string
7791
+ parent_acs_credential_id?: string | undefined
7792
+ display_name: string
7793
+ code?: (string | undefined) | null
7794
+ card_number?: (string | undefined) | null
7795
+ is_issued?: boolean | undefined
7796
+ issued_at?: (string | undefined) | null
7797
+ access_method: 'code' | 'card' | 'mobile_key'
7798
+ external_type?:
7799
+ | (
7800
+ | 'pti_card'
7801
+ | 'brivo_credential'
7802
+ | 'hid_credential'
7803
+ | 'visionline_card'
7804
+ | 'salto_ks_credential'
7805
+ )
7806
+ | undefined
7807
+ external_type_display_name?: string | undefined
7808
+ created_at: string
7809
+ workspace_id: string
7810
+ starts_at?: string | undefined
7811
+ ends_at?: string | undefined
7812
+ errors: Array<{
7813
+ error_code: string
7814
+ message: string
7815
+ }>
7816
+ warnings: Array<{
7817
+ warning_code: string
7818
+ message: string
7819
+ }>
7820
+ is_multi_phone_sync_credential?: boolean | undefined
7821
+ is_latest_desired_state_synced_with_provider?:
7822
+ | boolean
7823
+ | undefined
7824
+ latest_desired_state_synced_with_provider_at?:
7825
+ | string
7826
+ | undefined
7827
+ visionline_metadata?:
7828
+ | {
7829
+ card_function_type: 'guest' | 'staff'
7830
+ joiner_acs_credential_ids?: string[] | undefined
7831
+ guest_acs_entrance_ids?: string[] | undefined
7832
+ common_acs_entrance_ids?: string[] | undefined
7833
+ is_valid?: boolean | undefined
7834
+ auto_join?: boolean | undefined
7835
+ card_id?: string | undefined
7836
+ credential_id?: string | undefined
7837
+ }
7838
+ | undefined
7839
+ is_managed: false
7840
+ }
7841
+ )
7842
+ | null
7843
+ }
7844
+ }
7845
+ | {
7846
+ /** The ID of the action attempt. */
7847
+ action_attempt_id: string
7848
+ status: 'error'
7849
+ result: null
7850
+ action_type: 'SCAN_CARD'
6871
7851
  error: {
6872
7852
  type: 'no_card_on_encoder'
6873
7853
  message: string
@@ -7356,25 +8336,165 @@ export interface Routes {
7356
8336
  status: 'pending'
7357
8337
  result: null
7358
8338
  error: null
7359
- action_type: 'READ_CARD'
8339
+ action_type: 'SCAN_CARD'
7360
8340
  }
7361
8341
  | {
7362
8342
  /** The ID of the action attempt. */
7363
8343
  action_attempt_id: string
7364
8344
  status: 'success'
7365
8345
  error: null
7366
- action_type: 'READ_CARD'
8346
+ action_type: 'SCAN_CARD'
7367
8347
  result: {
7368
- /** A number or string that physically identifies this card. */
7369
- card_number: string | null
7370
- }
7371
- }
7372
- | {
7373
- /** The ID of the action attempt. */
7374
- action_attempt_id: string
7375
- status: 'error'
7376
- result: null
7377
- action_type: 'READ_CARD'
8348
+ /** Snapshot of the card data read from the physical encoder. */
8349
+ acs_credential_on_encoder: {
8350
+ /** Date and time the credential was created. */
8351
+ created_at: string
8352
+ is_issued: boolean | null
8353
+ /** Date and time the credential will become useable. */
8354
+ starts_at: string | null
8355
+ /** Date and time the credential will stop being useable. */
8356
+ ends_at: string | null
8357
+ /** A number or string that physically identifies this card. */
8358
+ card_number: string | null
8359
+ visionline_metadata?:
8360
+ | {
8361
+ card_id: string
8362
+ card_function_type: 'guest' | 'staff'
8363
+ cancelled: boolean
8364
+ discarded: boolean
8365
+ expired: boolean
8366
+ overwritten: boolean
8367
+ overridden?: boolean | undefined
8368
+ pending_auto_update: boolean
8369
+ card_format: 'TLCode' | 'rfid48'
8370
+ card_holder?: string | undefined
8371
+ number_of_issued_cards: number
8372
+ }
8373
+ | undefined
8374
+ }
8375
+ /** Matching acs_credential currently encoded on this card. */
8376
+ acs_credential_on_seam:
8377
+ | (
8378
+ | {
8379
+ acs_credential_id: string
8380
+ acs_user_id?: string | undefined
8381
+ acs_credential_pool_id?: string | undefined
8382
+ acs_system_id: string
8383
+ parent_acs_credential_id?: string | undefined
8384
+ display_name: string
8385
+ code?: (string | undefined) | null
8386
+ card_number?: (string | undefined) | null
8387
+ is_issued?: boolean | undefined
8388
+ issued_at?: (string | undefined) | null
8389
+ access_method: 'code' | 'card' | 'mobile_key'
8390
+ external_type?:
8391
+ | (
8392
+ | 'pti_card'
8393
+ | 'brivo_credential'
8394
+ | 'hid_credential'
8395
+ | 'visionline_card'
8396
+ | 'salto_ks_credential'
8397
+ )
8398
+ | undefined
8399
+ external_type_display_name?: string | undefined
8400
+ created_at: string
8401
+ workspace_id: string
8402
+ starts_at?: string | undefined
8403
+ ends_at?: string | undefined
8404
+ errors: Array<{
8405
+ error_code: string
8406
+ message: string
8407
+ }>
8408
+ warnings: Array<{
8409
+ warning_code: string
8410
+ message: string
8411
+ }>
8412
+ is_multi_phone_sync_credential?: boolean | undefined
8413
+ is_latest_desired_state_synced_with_provider?:
8414
+ | boolean
8415
+ | undefined
8416
+ latest_desired_state_synced_with_provider_at?:
8417
+ | string
8418
+ | undefined
8419
+ visionline_metadata?:
8420
+ | {
8421
+ card_function_type: 'guest' | 'staff'
8422
+ joiner_acs_credential_ids?: string[] | undefined
8423
+ guest_acs_entrance_ids?: string[] | undefined
8424
+ common_acs_entrance_ids?: string[] | undefined
8425
+ is_valid?: boolean | undefined
8426
+ auto_join?: boolean | undefined
8427
+ card_id?: string | undefined
8428
+ credential_id?: string | undefined
8429
+ }
8430
+ | undefined
8431
+ is_managed: true
8432
+ }
8433
+ | {
8434
+ acs_credential_id: string
8435
+ acs_user_id?: string | undefined
8436
+ acs_credential_pool_id?: string | undefined
8437
+ acs_system_id: string
8438
+ parent_acs_credential_id?: string | undefined
8439
+ display_name: string
8440
+ code?: (string | undefined) | null
8441
+ card_number?: (string | undefined) | null
8442
+ is_issued?: boolean | undefined
8443
+ issued_at?: (string | undefined) | null
8444
+ access_method: 'code' | 'card' | 'mobile_key'
8445
+ external_type?:
8446
+ | (
8447
+ | 'pti_card'
8448
+ | 'brivo_credential'
8449
+ | 'hid_credential'
8450
+ | 'visionline_card'
8451
+ | 'salto_ks_credential'
8452
+ )
8453
+ | undefined
8454
+ external_type_display_name?: string | undefined
8455
+ created_at: string
8456
+ workspace_id: string
8457
+ starts_at?: string | undefined
8458
+ ends_at?: string | undefined
8459
+ errors: Array<{
8460
+ error_code: string
8461
+ message: string
8462
+ }>
8463
+ warnings: Array<{
8464
+ warning_code: string
8465
+ message: string
8466
+ }>
8467
+ is_multi_phone_sync_credential?: boolean | undefined
8468
+ is_latest_desired_state_synced_with_provider?:
8469
+ | boolean
8470
+ | undefined
8471
+ latest_desired_state_synced_with_provider_at?:
8472
+ | string
8473
+ | undefined
8474
+ visionline_metadata?:
8475
+ | {
8476
+ card_function_type: 'guest' | 'staff'
8477
+ joiner_acs_credential_ids?: string[] | undefined
8478
+ guest_acs_entrance_ids?: string[] | undefined
8479
+ common_acs_entrance_ids?: string[] | undefined
8480
+ is_valid?: boolean | undefined
8481
+ auto_join?: boolean | undefined
8482
+ card_id?: string | undefined
8483
+ credential_id?: string | undefined
8484
+ }
8485
+ | undefined
8486
+ is_managed: false
8487
+ }
8488
+ )
8489
+ | null
8490
+ }
8491
+ }
8492
+ | {
8493
+ /** The ID of the action attempt. */
8494
+ action_attempt_id: string
8495
+ status: 'error'
8496
+ result: null
8497
+ action_type: 'SCAN_CARD'
7378
8498
  error: {
7379
8499
  type: 'no_card_on_encoder'
7380
8500
  message: string
@@ -13249,25 +14369,165 @@ export interface Routes {
13249
14369
  status: 'pending'
13250
14370
  result: null
13251
14371
  error: null
13252
- action_type: 'READ_CARD'
14372
+ action_type: 'SCAN_CARD'
13253
14373
  }
13254
14374
  | {
13255
14375
  /** The ID of the action attempt. */
13256
14376
  action_attempt_id: string
13257
14377
  status: 'success'
13258
14378
  error: null
13259
- action_type: 'READ_CARD'
14379
+ action_type: 'SCAN_CARD'
13260
14380
  result: {
13261
- /** A number or string that physically identifies this card. */
13262
- card_number: string | null
13263
- }
13264
- }
13265
- | {
13266
- /** The ID of the action attempt. */
13267
- action_attempt_id: string
13268
- status: 'error'
13269
- result: null
13270
- action_type: 'READ_CARD'
14381
+ /** Snapshot of the card data read from the physical encoder. */
14382
+ acs_credential_on_encoder: {
14383
+ /** Date and time the credential was created. */
14384
+ created_at: string
14385
+ is_issued: boolean | null
14386
+ /** Date and time the credential will become useable. */
14387
+ starts_at: string | null
14388
+ /** Date and time the credential will stop being useable. */
14389
+ ends_at: string | null
14390
+ /** A number or string that physically identifies this card. */
14391
+ card_number: string | null
14392
+ visionline_metadata?:
14393
+ | {
14394
+ card_id: string
14395
+ card_function_type: 'guest' | 'staff'
14396
+ cancelled: boolean
14397
+ discarded: boolean
14398
+ expired: boolean
14399
+ overwritten: boolean
14400
+ overridden?: boolean | undefined
14401
+ pending_auto_update: boolean
14402
+ card_format: 'TLCode' | 'rfid48'
14403
+ card_holder?: string | undefined
14404
+ number_of_issued_cards: number
14405
+ }
14406
+ | undefined
14407
+ }
14408
+ /** Matching acs_credential currently encoded on this card. */
14409
+ acs_credential_on_seam:
14410
+ | (
14411
+ | {
14412
+ acs_credential_id: string
14413
+ acs_user_id?: string | undefined
14414
+ acs_credential_pool_id?: string | undefined
14415
+ acs_system_id: string
14416
+ parent_acs_credential_id?: string | undefined
14417
+ display_name: string
14418
+ code?: (string | undefined) | null
14419
+ card_number?: (string | undefined) | null
14420
+ is_issued?: boolean | undefined
14421
+ issued_at?: (string | undefined) | null
14422
+ access_method: 'code' | 'card' | 'mobile_key'
14423
+ external_type?:
14424
+ | (
14425
+ | 'pti_card'
14426
+ | 'brivo_credential'
14427
+ | 'hid_credential'
14428
+ | 'visionline_card'
14429
+ | 'salto_ks_credential'
14430
+ )
14431
+ | undefined
14432
+ external_type_display_name?: string | undefined
14433
+ created_at: string
14434
+ workspace_id: string
14435
+ starts_at?: string | undefined
14436
+ ends_at?: string | undefined
14437
+ errors: Array<{
14438
+ error_code: string
14439
+ message: string
14440
+ }>
14441
+ warnings: Array<{
14442
+ warning_code: string
14443
+ message: string
14444
+ }>
14445
+ is_multi_phone_sync_credential?: boolean | undefined
14446
+ is_latest_desired_state_synced_with_provider?:
14447
+ | boolean
14448
+ | undefined
14449
+ latest_desired_state_synced_with_provider_at?:
14450
+ | string
14451
+ | undefined
14452
+ visionline_metadata?:
14453
+ | {
14454
+ card_function_type: 'guest' | 'staff'
14455
+ joiner_acs_credential_ids?: string[] | undefined
14456
+ guest_acs_entrance_ids?: string[] | undefined
14457
+ common_acs_entrance_ids?: string[] | undefined
14458
+ is_valid?: boolean | undefined
14459
+ auto_join?: boolean | undefined
14460
+ card_id?: string | undefined
14461
+ credential_id?: string | undefined
14462
+ }
14463
+ | undefined
14464
+ is_managed: true
14465
+ }
14466
+ | {
14467
+ acs_credential_id: string
14468
+ acs_user_id?: string | undefined
14469
+ acs_credential_pool_id?: string | undefined
14470
+ acs_system_id: string
14471
+ parent_acs_credential_id?: string | undefined
14472
+ display_name: string
14473
+ code?: (string | undefined) | null
14474
+ card_number?: (string | undefined) | null
14475
+ is_issued?: boolean | undefined
14476
+ issued_at?: (string | undefined) | null
14477
+ access_method: 'code' | 'card' | 'mobile_key'
14478
+ external_type?:
14479
+ | (
14480
+ | 'pti_card'
14481
+ | 'brivo_credential'
14482
+ | 'hid_credential'
14483
+ | 'visionline_card'
14484
+ | 'salto_ks_credential'
14485
+ )
14486
+ | undefined
14487
+ external_type_display_name?: string | undefined
14488
+ created_at: string
14489
+ workspace_id: string
14490
+ starts_at?: string | undefined
14491
+ ends_at?: string | undefined
14492
+ errors: Array<{
14493
+ error_code: string
14494
+ message: string
14495
+ }>
14496
+ warnings: Array<{
14497
+ warning_code: string
14498
+ message: string
14499
+ }>
14500
+ is_multi_phone_sync_credential?: boolean | undefined
14501
+ is_latest_desired_state_synced_with_provider?:
14502
+ | boolean
14503
+ | undefined
14504
+ latest_desired_state_synced_with_provider_at?:
14505
+ | string
14506
+ | undefined
14507
+ visionline_metadata?:
14508
+ | {
14509
+ card_function_type: 'guest' | 'staff'
14510
+ joiner_acs_credential_ids?: string[] | undefined
14511
+ guest_acs_entrance_ids?: string[] | undefined
14512
+ common_acs_entrance_ids?: string[] | undefined
14513
+ is_valid?: boolean | undefined
14514
+ auto_join?: boolean | undefined
14515
+ card_id?: string | undefined
14516
+ credential_id?: string | undefined
14517
+ }
14518
+ | undefined
14519
+ is_managed: false
14520
+ }
14521
+ )
14522
+ | null
14523
+ }
14524
+ }
14525
+ | {
14526
+ /** The ID of the action attempt. */
14527
+ action_attempt_id: string
14528
+ status: 'error'
14529
+ result: null
14530
+ action_type: 'SCAN_CARD'
13271
14531
  error: {
13272
14532
  type: 'no_card_on_encoder'
13273
14533
  message: string
@@ -13757,25 +15017,165 @@ export interface Routes {
13757
15017
  status: 'pending'
13758
15018
  result: null
13759
15019
  error: null
13760
- action_type: 'READ_CARD'
15020
+ action_type: 'SCAN_CARD'
13761
15021
  }
13762
15022
  | {
13763
15023
  /** The ID of the action attempt. */
13764
15024
  action_attempt_id: string
13765
15025
  status: 'success'
13766
15026
  error: null
13767
- action_type: 'READ_CARD'
15027
+ action_type: 'SCAN_CARD'
13768
15028
  result: {
13769
- /** A number or string that physically identifies this card. */
13770
- card_number: string | null
13771
- }
13772
- }
13773
- | {
13774
- /** The ID of the action attempt. */
13775
- action_attempt_id: string
13776
- status: 'error'
13777
- result: null
13778
- action_type: 'READ_CARD'
15029
+ /** Snapshot of the card data read from the physical encoder. */
15030
+ acs_credential_on_encoder: {
15031
+ /** Date and time the credential was created. */
15032
+ created_at: string
15033
+ is_issued: boolean | null
15034
+ /** Date and time the credential will become useable. */
15035
+ starts_at: string | null
15036
+ /** Date and time the credential will stop being useable. */
15037
+ ends_at: string | null
15038
+ /** A number or string that physically identifies this card. */
15039
+ card_number: string | null
15040
+ visionline_metadata?:
15041
+ | {
15042
+ card_id: string
15043
+ card_function_type: 'guest' | 'staff'
15044
+ cancelled: boolean
15045
+ discarded: boolean
15046
+ expired: boolean
15047
+ overwritten: boolean
15048
+ overridden?: boolean | undefined
15049
+ pending_auto_update: boolean
15050
+ card_format: 'TLCode' | 'rfid48'
15051
+ card_holder?: string | undefined
15052
+ number_of_issued_cards: number
15053
+ }
15054
+ | undefined
15055
+ }
15056
+ /** Matching acs_credential currently encoded on this card. */
15057
+ acs_credential_on_seam:
15058
+ | (
15059
+ | {
15060
+ acs_credential_id: string
15061
+ acs_user_id?: string | undefined
15062
+ acs_credential_pool_id?: string | undefined
15063
+ acs_system_id: string
15064
+ parent_acs_credential_id?: string | undefined
15065
+ display_name: string
15066
+ code?: (string | undefined) | null
15067
+ card_number?: (string | undefined) | null
15068
+ is_issued?: boolean | undefined
15069
+ issued_at?: (string | undefined) | null
15070
+ access_method: 'code' | 'card' | 'mobile_key'
15071
+ external_type?:
15072
+ | (
15073
+ | 'pti_card'
15074
+ | 'brivo_credential'
15075
+ | 'hid_credential'
15076
+ | 'visionline_card'
15077
+ | 'salto_ks_credential'
15078
+ )
15079
+ | undefined
15080
+ external_type_display_name?: string | undefined
15081
+ created_at: string
15082
+ workspace_id: string
15083
+ starts_at?: string | undefined
15084
+ ends_at?: string | undefined
15085
+ errors: Array<{
15086
+ error_code: string
15087
+ message: string
15088
+ }>
15089
+ warnings: Array<{
15090
+ warning_code: string
15091
+ message: string
15092
+ }>
15093
+ is_multi_phone_sync_credential?: boolean | undefined
15094
+ is_latest_desired_state_synced_with_provider?:
15095
+ | boolean
15096
+ | undefined
15097
+ latest_desired_state_synced_with_provider_at?:
15098
+ | string
15099
+ | undefined
15100
+ visionline_metadata?:
15101
+ | {
15102
+ card_function_type: 'guest' | 'staff'
15103
+ joiner_acs_credential_ids?: string[] | undefined
15104
+ guest_acs_entrance_ids?: string[] | undefined
15105
+ common_acs_entrance_ids?: string[] | undefined
15106
+ is_valid?: boolean | undefined
15107
+ auto_join?: boolean | undefined
15108
+ card_id?: string | undefined
15109
+ credential_id?: string | undefined
15110
+ }
15111
+ | undefined
15112
+ is_managed: true
15113
+ }
15114
+ | {
15115
+ acs_credential_id: string
15116
+ acs_user_id?: string | undefined
15117
+ acs_credential_pool_id?: string | undefined
15118
+ acs_system_id: string
15119
+ parent_acs_credential_id?: string | undefined
15120
+ display_name: string
15121
+ code?: (string | undefined) | null
15122
+ card_number?: (string | undefined) | null
15123
+ is_issued?: boolean | undefined
15124
+ issued_at?: (string | undefined) | null
15125
+ access_method: 'code' | 'card' | 'mobile_key'
15126
+ external_type?:
15127
+ | (
15128
+ | 'pti_card'
15129
+ | 'brivo_credential'
15130
+ | 'hid_credential'
15131
+ | 'visionline_card'
15132
+ | 'salto_ks_credential'
15133
+ )
15134
+ | undefined
15135
+ external_type_display_name?: string | undefined
15136
+ created_at: string
15137
+ workspace_id: string
15138
+ starts_at?: string | undefined
15139
+ ends_at?: string | undefined
15140
+ errors: Array<{
15141
+ error_code: string
15142
+ message: string
15143
+ }>
15144
+ warnings: Array<{
15145
+ warning_code: string
15146
+ message: string
15147
+ }>
15148
+ is_multi_phone_sync_credential?: boolean | undefined
15149
+ is_latest_desired_state_synced_with_provider?:
15150
+ | boolean
15151
+ | undefined
15152
+ latest_desired_state_synced_with_provider_at?:
15153
+ | string
15154
+ | undefined
15155
+ visionline_metadata?:
15156
+ | {
15157
+ card_function_type: 'guest' | 'staff'
15158
+ joiner_acs_credential_ids?: string[] | undefined
15159
+ guest_acs_entrance_ids?: string[] | undefined
15160
+ common_acs_entrance_ids?: string[] | undefined
15161
+ is_valid?: boolean | undefined
15162
+ auto_join?: boolean | undefined
15163
+ card_id?: string | undefined
15164
+ credential_id?: string | undefined
15165
+ }
15166
+ | undefined
15167
+ is_managed: false
15168
+ }
15169
+ )
15170
+ | null
15171
+ }
15172
+ }
15173
+ | {
15174
+ /** The ID of the action attempt. */
15175
+ action_attempt_id: string
15176
+ status: 'error'
15177
+ result: null
15178
+ action_type: 'SCAN_CARD'
13779
15179
  error: {
13780
15180
  type: 'no_card_on_encoder'
13781
15181
  message: string
@@ -15701,25 +17101,165 @@ export interface Routes {
15701
17101
  status: 'pending'
15702
17102
  result: null
15703
17103
  error: null
15704
- action_type: 'READ_CARD'
17104
+ action_type: 'SCAN_CARD'
15705
17105
  }
15706
17106
  | {
15707
17107
  /** The ID of the action attempt. */
15708
17108
  action_attempt_id: string
15709
17109
  status: 'success'
15710
17110
  error: null
15711
- action_type: 'READ_CARD'
17111
+ action_type: 'SCAN_CARD'
15712
17112
  result: {
15713
- /** A number or string that physically identifies this card. */
15714
- card_number: string | null
15715
- }
15716
- }
15717
- | {
15718
- /** The ID of the action attempt. */
15719
- action_attempt_id: string
15720
- status: 'error'
15721
- result: null
15722
- action_type: 'READ_CARD'
17113
+ /** Snapshot of the card data read from the physical encoder. */
17114
+ acs_credential_on_encoder: {
17115
+ /** Date and time the credential was created. */
17116
+ created_at: string
17117
+ is_issued: boolean | null
17118
+ /** Date and time the credential will become useable. */
17119
+ starts_at: string | null
17120
+ /** Date and time the credential will stop being useable. */
17121
+ ends_at: string | null
17122
+ /** A number or string that physically identifies this card. */
17123
+ card_number: string | null
17124
+ visionline_metadata?:
17125
+ | {
17126
+ card_id: string
17127
+ card_function_type: 'guest' | 'staff'
17128
+ cancelled: boolean
17129
+ discarded: boolean
17130
+ expired: boolean
17131
+ overwritten: boolean
17132
+ overridden?: boolean | undefined
17133
+ pending_auto_update: boolean
17134
+ card_format: 'TLCode' | 'rfid48'
17135
+ card_holder?: string | undefined
17136
+ number_of_issued_cards: number
17137
+ }
17138
+ | undefined
17139
+ }
17140
+ /** Matching acs_credential currently encoded on this card. */
17141
+ acs_credential_on_seam:
17142
+ | (
17143
+ | {
17144
+ acs_credential_id: string
17145
+ acs_user_id?: string | undefined
17146
+ acs_credential_pool_id?: string | undefined
17147
+ acs_system_id: string
17148
+ parent_acs_credential_id?: string | undefined
17149
+ display_name: string
17150
+ code?: (string | undefined) | null
17151
+ card_number?: (string | undefined) | null
17152
+ is_issued?: boolean | undefined
17153
+ issued_at?: (string | undefined) | null
17154
+ access_method: 'code' | 'card' | 'mobile_key'
17155
+ external_type?:
17156
+ | (
17157
+ | 'pti_card'
17158
+ | 'brivo_credential'
17159
+ | 'hid_credential'
17160
+ | 'visionline_card'
17161
+ | 'salto_ks_credential'
17162
+ )
17163
+ | undefined
17164
+ external_type_display_name?: string | undefined
17165
+ created_at: string
17166
+ workspace_id: string
17167
+ starts_at?: string | undefined
17168
+ ends_at?: string | undefined
17169
+ errors: Array<{
17170
+ error_code: string
17171
+ message: string
17172
+ }>
17173
+ warnings: Array<{
17174
+ warning_code: string
17175
+ message: string
17176
+ }>
17177
+ is_multi_phone_sync_credential?: boolean | undefined
17178
+ is_latest_desired_state_synced_with_provider?:
17179
+ | boolean
17180
+ | undefined
17181
+ latest_desired_state_synced_with_provider_at?:
17182
+ | string
17183
+ | undefined
17184
+ visionline_metadata?:
17185
+ | {
17186
+ card_function_type: 'guest' | 'staff'
17187
+ joiner_acs_credential_ids?: string[] | undefined
17188
+ guest_acs_entrance_ids?: string[] | undefined
17189
+ common_acs_entrance_ids?: string[] | undefined
17190
+ is_valid?: boolean | undefined
17191
+ auto_join?: boolean | undefined
17192
+ card_id?: string | undefined
17193
+ credential_id?: string | undefined
17194
+ }
17195
+ | undefined
17196
+ is_managed: true
17197
+ }
17198
+ | {
17199
+ acs_credential_id: string
17200
+ acs_user_id?: string | undefined
17201
+ acs_credential_pool_id?: string | undefined
17202
+ acs_system_id: string
17203
+ parent_acs_credential_id?: string | undefined
17204
+ display_name: string
17205
+ code?: (string | undefined) | null
17206
+ card_number?: (string | undefined) | null
17207
+ is_issued?: boolean | undefined
17208
+ issued_at?: (string | undefined) | null
17209
+ access_method: 'code' | 'card' | 'mobile_key'
17210
+ external_type?:
17211
+ | (
17212
+ | 'pti_card'
17213
+ | 'brivo_credential'
17214
+ | 'hid_credential'
17215
+ | 'visionline_card'
17216
+ | 'salto_ks_credential'
17217
+ )
17218
+ | undefined
17219
+ external_type_display_name?: string | undefined
17220
+ created_at: string
17221
+ workspace_id: string
17222
+ starts_at?: string | undefined
17223
+ ends_at?: string | undefined
17224
+ errors: Array<{
17225
+ error_code: string
17226
+ message: string
17227
+ }>
17228
+ warnings: Array<{
17229
+ warning_code: string
17230
+ message: string
17231
+ }>
17232
+ is_multi_phone_sync_credential?: boolean | undefined
17233
+ is_latest_desired_state_synced_with_provider?:
17234
+ | boolean
17235
+ | undefined
17236
+ latest_desired_state_synced_with_provider_at?:
17237
+ | string
17238
+ | undefined
17239
+ visionline_metadata?:
17240
+ | {
17241
+ card_function_type: 'guest' | 'staff'
17242
+ joiner_acs_credential_ids?: string[] | undefined
17243
+ guest_acs_entrance_ids?: string[] | undefined
17244
+ common_acs_entrance_ids?: string[] | undefined
17245
+ is_valid?: boolean | undefined
17246
+ auto_join?: boolean | undefined
17247
+ card_id?: string | undefined
17248
+ credential_id?: string | undefined
17249
+ }
17250
+ | undefined
17251
+ is_managed: false
17252
+ }
17253
+ )
17254
+ | null
17255
+ }
17256
+ }
17257
+ | {
17258
+ /** The ID of the action attempt. */
17259
+ action_attempt_id: string
17260
+ status: 'error'
17261
+ result: null
17262
+ action_type: 'SCAN_CARD'
15723
17263
  error: {
15724
17264
  type: 'no_card_on_encoder'
15725
17265
  message: string
@@ -16219,25 +17759,165 @@ export interface Routes {
16219
17759
  status: 'pending'
16220
17760
  result: null
16221
17761
  error: null
16222
- action_type: 'READ_CARD'
17762
+ action_type: 'SCAN_CARD'
16223
17763
  }
16224
17764
  | {
16225
17765
  /** The ID of the action attempt. */
16226
17766
  action_attempt_id: string
16227
17767
  status: 'success'
16228
17768
  error: null
16229
- action_type: 'READ_CARD'
17769
+ action_type: 'SCAN_CARD'
16230
17770
  result: {
16231
- /** A number or string that physically identifies this card. */
16232
- card_number: string | null
16233
- }
16234
- }
16235
- | {
16236
- /** The ID of the action attempt. */
16237
- action_attempt_id: string
16238
- status: 'error'
16239
- result: null
16240
- action_type: 'READ_CARD'
17771
+ /** Snapshot of the card data read from the physical encoder. */
17772
+ acs_credential_on_encoder: {
17773
+ /** Date and time the credential was created. */
17774
+ created_at: string
17775
+ is_issued: boolean | null
17776
+ /** Date and time the credential will become useable. */
17777
+ starts_at: string | null
17778
+ /** Date and time the credential will stop being useable. */
17779
+ ends_at: string | null
17780
+ /** A number or string that physically identifies this card. */
17781
+ card_number: string | null
17782
+ visionline_metadata?:
17783
+ | {
17784
+ card_id: string
17785
+ card_function_type: 'guest' | 'staff'
17786
+ cancelled: boolean
17787
+ discarded: boolean
17788
+ expired: boolean
17789
+ overwritten: boolean
17790
+ overridden?: boolean | undefined
17791
+ pending_auto_update: boolean
17792
+ card_format: 'TLCode' | 'rfid48'
17793
+ card_holder?: string | undefined
17794
+ number_of_issued_cards: number
17795
+ }
17796
+ | undefined
17797
+ }
17798
+ /** Matching acs_credential currently encoded on this card. */
17799
+ acs_credential_on_seam:
17800
+ | (
17801
+ | {
17802
+ acs_credential_id: string
17803
+ acs_user_id?: string | undefined
17804
+ acs_credential_pool_id?: string | undefined
17805
+ acs_system_id: string
17806
+ parent_acs_credential_id?: string | undefined
17807
+ display_name: string
17808
+ code?: (string | undefined) | null
17809
+ card_number?: (string | undefined) | null
17810
+ is_issued?: boolean | undefined
17811
+ issued_at?: (string | undefined) | null
17812
+ access_method: 'code' | 'card' | 'mobile_key'
17813
+ external_type?:
17814
+ | (
17815
+ | 'pti_card'
17816
+ | 'brivo_credential'
17817
+ | 'hid_credential'
17818
+ | 'visionline_card'
17819
+ | 'salto_ks_credential'
17820
+ )
17821
+ | undefined
17822
+ external_type_display_name?: string | undefined
17823
+ created_at: string
17824
+ workspace_id: string
17825
+ starts_at?: string | undefined
17826
+ ends_at?: string | undefined
17827
+ errors: Array<{
17828
+ error_code: string
17829
+ message: string
17830
+ }>
17831
+ warnings: Array<{
17832
+ warning_code: string
17833
+ message: string
17834
+ }>
17835
+ is_multi_phone_sync_credential?: boolean | undefined
17836
+ is_latest_desired_state_synced_with_provider?:
17837
+ | boolean
17838
+ | undefined
17839
+ latest_desired_state_synced_with_provider_at?:
17840
+ | string
17841
+ | undefined
17842
+ visionline_metadata?:
17843
+ | {
17844
+ card_function_type: 'guest' | 'staff'
17845
+ joiner_acs_credential_ids?: string[] | undefined
17846
+ guest_acs_entrance_ids?: string[] | undefined
17847
+ common_acs_entrance_ids?: string[] | undefined
17848
+ is_valid?: boolean | undefined
17849
+ auto_join?: boolean | undefined
17850
+ card_id?: string | undefined
17851
+ credential_id?: string | undefined
17852
+ }
17853
+ | undefined
17854
+ is_managed: true
17855
+ }
17856
+ | {
17857
+ acs_credential_id: string
17858
+ acs_user_id?: string | undefined
17859
+ acs_credential_pool_id?: string | undefined
17860
+ acs_system_id: string
17861
+ parent_acs_credential_id?: string | undefined
17862
+ display_name: string
17863
+ code?: (string | undefined) | null
17864
+ card_number?: (string | undefined) | null
17865
+ is_issued?: boolean | undefined
17866
+ issued_at?: (string | undefined) | null
17867
+ access_method: 'code' | 'card' | 'mobile_key'
17868
+ external_type?:
17869
+ | (
17870
+ | 'pti_card'
17871
+ | 'brivo_credential'
17872
+ | 'hid_credential'
17873
+ | 'visionline_card'
17874
+ | 'salto_ks_credential'
17875
+ )
17876
+ | undefined
17877
+ external_type_display_name?: string | undefined
17878
+ created_at: string
17879
+ workspace_id: string
17880
+ starts_at?: string | undefined
17881
+ ends_at?: string | undefined
17882
+ errors: Array<{
17883
+ error_code: string
17884
+ message: string
17885
+ }>
17886
+ warnings: Array<{
17887
+ warning_code: string
17888
+ message: string
17889
+ }>
17890
+ is_multi_phone_sync_credential?: boolean | undefined
17891
+ is_latest_desired_state_synced_with_provider?:
17892
+ | boolean
17893
+ | undefined
17894
+ latest_desired_state_synced_with_provider_at?:
17895
+ | string
17896
+ | undefined
17897
+ visionline_metadata?:
17898
+ | {
17899
+ card_function_type: 'guest' | 'staff'
17900
+ joiner_acs_credential_ids?: string[] | undefined
17901
+ guest_acs_entrance_ids?: string[] | undefined
17902
+ common_acs_entrance_ids?: string[] | undefined
17903
+ is_valid?: boolean | undefined
17904
+ auto_join?: boolean | undefined
17905
+ card_id?: string | undefined
17906
+ credential_id?: string | undefined
17907
+ }
17908
+ | undefined
17909
+ is_managed: false
17910
+ }
17911
+ )
17912
+ | null
17913
+ }
17914
+ }
17915
+ | {
17916
+ /** The ID of the action attempt. */
17917
+ action_attempt_id: string
17918
+ status: 'error'
17919
+ result: null
17920
+ action_type: 'SCAN_CARD'
16241
17921
  error: {
16242
17922
  type: 'no_card_on_encoder'
16243
17923
  message: string
@@ -16776,25 +18456,165 @@ export interface Routes {
16776
18456
  status: 'pending'
16777
18457
  result: null
16778
18458
  error: null
16779
- action_type: 'READ_CARD'
18459
+ action_type: 'SCAN_CARD'
16780
18460
  }
16781
18461
  | {
16782
18462
  /** The ID of the action attempt. */
16783
18463
  action_attempt_id: string
16784
18464
  status: 'success'
16785
18465
  error: null
16786
- action_type: 'READ_CARD'
18466
+ action_type: 'SCAN_CARD'
16787
18467
  result: {
16788
- /** A number or string that physically identifies this card. */
16789
- card_number: string | null
16790
- }
16791
- }
16792
- | {
16793
- /** The ID of the action attempt. */
16794
- action_attempt_id: string
16795
- status: 'error'
16796
- result: null
16797
- action_type: 'READ_CARD'
18468
+ /** Snapshot of the card data read from the physical encoder. */
18469
+ acs_credential_on_encoder: {
18470
+ /** Date and time the credential was created. */
18471
+ created_at: string
18472
+ is_issued: boolean | null
18473
+ /** Date and time the credential will become useable. */
18474
+ starts_at: string | null
18475
+ /** Date and time the credential will stop being useable. */
18476
+ ends_at: string | null
18477
+ /** A number or string that physically identifies this card. */
18478
+ card_number: string | null
18479
+ visionline_metadata?:
18480
+ | {
18481
+ card_id: string
18482
+ card_function_type: 'guest' | 'staff'
18483
+ cancelled: boolean
18484
+ discarded: boolean
18485
+ expired: boolean
18486
+ overwritten: boolean
18487
+ overridden?: boolean | undefined
18488
+ pending_auto_update: boolean
18489
+ card_format: 'TLCode' | 'rfid48'
18490
+ card_holder?: string | undefined
18491
+ number_of_issued_cards: number
18492
+ }
18493
+ | undefined
18494
+ }
18495
+ /** Matching acs_credential currently encoded on this card. */
18496
+ acs_credential_on_seam:
18497
+ | (
18498
+ | {
18499
+ acs_credential_id: string
18500
+ acs_user_id?: string | undefined
18501
+ acs_credential_pool_id?: string | undefined
18502
+ acs_system_id: string
18503
+ parent_acs_credential_id?: string | undefined
18504
+ display_name: string
18505
+ code?: (string | undefined) | null
18506
+ card_number?: (string | undefined) | null
18507
+ is_issued?: boolean | undefined
18508
+ issued_at?: (string | undefined) | null
18509
+ access_method: 'code' | 'card' | 'mobile_key'
18510
+ external_type?:
18511
+ | (
18512
+ | 'pti_card'
18513
+ | 'brivo_credential'
18514
+ | 'hid_credential'
18515
+ | 'visionline_card'
18516
+ | 'salto_ks_credential'
18517
+ )
18518
+ | undefined
18519
+ external_type_display_name?: string | undefined
18520
+ created_at: string
18521
+ workspace_id: string
18522
+ starts_at?: string | undefined
18523
+ ends_at?: string | undefined
18524
+ errors: Array<{
18525
+ error_code: string
18526
+ message: string
18527
+ }>
18528
+ warnings: Array<{
18529
+ warning_code: string
18530
+ message: string
18531
+ }>
18532
+ is_multi_phone_sync_credential?: boolean | undefined
18533
+ is_latest_desired_state_synced_with_provider?:
18534
+ | boolean
18535
+ | undefined
18536
+ latest_desired_state_synced_with_provider_at?:
18537
+ | string
18538
+ | undefined
18539
+ visionline_metadata?:
18540
+ | {
18541
+ card_function_type: 'guest' | 'staff'
18542
+ joiner_acs_credential_ids?: string[] | undefined
18543
+ guest_acs_entrance_ids?: string[] | undefined
18544
+ common_acs_entrance_ids?: string[] | undefined
18545
+ is_valid?: boolean | undefined
18546
+ auto_join?: boolean | undefined
18547
+ card_id?: string | undefined
18548
+ credential_id?: string | undefined
18549
+ }
18550
+ | undefined
18551
+ is_managed: true
18552
+ }
18553
+ | {
18554
+ acs_credential_id: string
18555
+ acs_user_id?: string | undefined
18556
+ acs_credential_pool_id?: string | undefined
18557
+ acs_system_id: string
18558
+ parent_acs_credential_id?: string | undefined
18559
+ display_name: string
18560
+ code?: (string | undefined) | null
18561
+ card_number?: (string | undefined) | null
18562
+ is_issued?: boolean | undefined
18563
+ issued_at?: (string | undefined) | null
18564
+ access_method: 'code' | 'card' | 'mobile_key'
18565
+ external_type?:
18566
+ | (
18567
+ | 'pti_card'
18568
+ | 'brivo_credential'
18569
+ | 'hid_credential'
18570
+ | 'visionline_card'
18571
+ | 'salto_ks_credential'
18572
+ )
18573
+ | undefined
18574
+ external_type_display_name?: string | undefined
18575
+ created_at: string
18576
+ workspace_id: string
18577
+ starts_at?: string | undefined
18578
+ ends_at?: string | undefined
18579
+ errors: Array<{
18580
+ error_code: string
18581
+ message: string
18582
+ }>
18583
+ warnings: Array<{
18584
+ warning_code: string
18585
+ message: string
18586
+ }>
18587
+ is_multi_phone_sync_credential?: boolean | undefined
18588
+ is_latest_desired_state_synced_with_provider?:
18589
+ | boolean
18590
+ | undefined
18591
+ latest_desired_state_synced_with_provider_at?:
18592
+ | string
18593
+ | undefined
18594
+ visionline_metadata?:
18595
+ | {
18596
+ card_function_type: 'guest' | 'staff'
18597
+ joiner_acs_credential_ids?: string[] | undefined
18598
+ guest_acs_entrance_ids?: string[] | undefined
18599
+ common_acs_entrance_ids?: string[] | undefined
18600
+ is_valid?: boolean | undefined
18601
+ auto_join?: boolean | undefined
18602
+ card_id?: string | undefined
18603
+ credential_id?: string | undefined
18604
+ }
18605
+ | undefined
18606
+ is_managed: false
18607
+ }
18608
+ )
18609
+ | null
18610
+ }
18611
+ }
18612
+ | {
18613
+ /** The ID of the action attempt. */
18614
+ action_attempt_id: string
18615
+ status: 'error'
18616
+ result: null
18617
+ action_type: 'SCAN_CARD'
16798
18618
  error: {
16799
18619
  type: 'no_card_on_encoder'
16800
18620
  message: string
@@ -17490,25 +19310,165 @@ export interface Routes {
17490
19310
  status: 'pending'
17491
19311
  result: null
17492
19312
  error: null
17493
- action_type: 'READ_CARD'
19313
+ action_type: 'SCAN_CARD'
17494
19314
  }
17495
19315
  | {
17496
19316
  /** The ID of the action attempt. */
17497
19317
  action_attempt_id: string
17498
19318
  status: 'success'
17499
19319
  error: null
17500
- action_type: 'READ_CARD'
19320
+ action_type: 'SCAN_CARD'
17501
19321
  result: {
17502
- /** A number or string that physically identifies this card. */
17503
- card_number: string | null
17504
- }
17505
- }
17506
- | {
17507
- /** The ID of the action attempt. */
17508
- action_attempt_id: string
17509
- status: 'error'
17510
- result: null
17511
- action_type: 'READ_CARD'
19322
+ /** Snapshot of the card data read from the physical encoder. */
19323
+ acs_credential_on_encoder: {
19324
+ /** Date and time the credential was created. */
19325
+ created_at: string
19326
+ is_issued: boolean | null
19327
+ /** Date and time the credential will become useable. */
19328
+ starts_at: string | null
19329
+ /** Date and time the credential will stop being useable. */
19330
+ ends_at: string | null
19331
+ /** A number or string that physically identifies this card. */
19332
+ card_number: string | null
19333
+ visionline_metadata?:
19334
+ | {
19335
+ card_id: string
19336
+ card_function_type: 'guest' | 'staff'
19337
+ cancelled: boolean
19338
+ discarded: boolean
19339
+ expired: boolean
19340
+ overwritten: boolean
19341
+ overridden?: boolean | undefined
19342
+ pending_auto_update: boolean
19343
+ card_format: 'TLCode' | 'rfid48'
19344
+ card_holder?: string | undefined
19345
+ number_of_issued_cards: number
19346
+ }
19347
+ | undefined
19348
+ }
19349
+ /** Matching acs_credential currently encoded on this card. */
19350
+ acs_credential_on_seam:
19351
+ | (
19352
+ | {
19353
+ acs_credential_id: string
19354
+ acs_user_id?: string | undefined
19355
+ acs_credential_pool_id?: string | undefined
19356
+ acs_system_id: string
19357
+ parent_acs_credential_id?: string | undefined
19358
+ display_name: string
19359
+ code?: (string | undefined) | null
19360
+ card_number?: (string | undefined) | null
19361
+ is_issued?: boolean | undefined
19362
+ issued_at?: (string | undefined) | null
19363
+ access_method: 'code' | 'card' | 'mobile_key'
19364
+ external_type?:
19365
+ | (
19366
+ | 'pti_card'
19367
+ | 'brivo_credential'
19368
+ | 'hid_credential'
19369
+ | 'visionline_card'
19370
+ | 'salto_ks_credential'
19371
+ )
19372
+ | undefined
19373
+ external_type_display_name?: string | undefined
19374
+ created_at: string
19375
+ workspace_id: string
19376
+ starts_at?: string | undefined
19377
+ ends_at?: string | undefined
19378
+ errors: Array<{
19379
+ error_code: string
19380
+ message: string
19381
+ }>
19382
+ warnings: Array<{
19383
+ warning_code: string
19384
+ message: string
19385
+ }>
19386
+ is_multi_phone_sync_credential?: boolean | undefined
19387
+ is_latest_desired_state_synced_with_provider?:
19388
+ | boolean
19389
+ | undefined
19390
+ latest_desired_state_synced_with_provider_at?:
19391
+ | string
19392
+ | undefined
19393
+ visionline_metadata?:
19394
+ | {
19395
+ card_function_type: 'guest' | 'staff'
19396
+ joiner_acs_credential_ids?: string[] | undefined
19397
+ guest_acs_entrance_ids?: string[] | undefined
19398
+ common_acs_entrance_ids?: string[] | undefined
19399
+ is_valid?: boolean | undefined
19400
+ auto_join?: boolean | undefined
19401
+ card_id?: string | undefined
19402
+ credential_id?: string | undefined
19403
+ }
19404
+ | undefined
19405
+ is_managed: true
19406
+ }
19407
+ | {
19408
+ acs_credential_id: string
19409
+ acs_user_id?: string | undefined
19410
+ acs_credential_pool_id?: string | undefined
19411
+ acs_system_id: string
19412
+ parent_acs_credential_id?: string | undefined
19413
+ display_name: string
19414
+ code?: (string | undefined) | null
19415
+ card_number?: (string | undefined) | null
19416
+ is_issued?: boolean | undefined
19417
+ issued_at?: (string | undefined) | null
19418
+ access_method: 'code' | 'card' | 'mobile_key'
19419
+ external_type?:
19420
+ | (
19421
+ | 'pti_card'
19422
+ | 'brivo_credential'
19423
+ | 'hid_credential'
19424
+ | 'visionline_card'
19425
+ | 'salto_ks_credential'
19426
+ )
19427
+ | undefined
19428
+ external_type_display_name?: string | undefined
19429
+ created_at: string
19430
+ workspace_id: string
19431
+ starts_at?: string | undefined
19432
+ ends_at?: string | undefined
19433
+ errors: Array<{
19434
+ error_code: string
19435
+ message: string
19436
+ }>
19437
+ warnings: Array<{
19438
+ warning_code: string
19439
+ message: string
19440
+ }>
19441
+ is_multi_phone_sync_credential?: boolean | undefined
19442
+ is_latest_desired_state_synced_with_provider?:
19443
+ | boolean
19444
+ | undefined
19445
+ latest_desired_state_synced_with_provider_at?:
19446
+ | string
19447
+ | undefined
19448
+ visionline_metadata?:
19449
+ | {
19450
+ card_function_type: 'guest' | 'staff'
19451
+ joiner_acs_credential_ids?: string[] | undefined
19452
+ guest_acs_entrance_ids?: string[] | undefined
19453
+ common_acs_entrance_ids?: string[] | undefined
19454
+ is_valid?: boolean | undefined
19455
+ auto_join?: boolean | undefined
19456
+ card_id?: string | undefined
19457
+ credential_id?: string | undefined
19458
+ }
19459
+ | undefined
19460
+ is_managed: false
19461
+ }
19462
+ )
19463
+ | null
19464
+ }
19465
+ }
19466
+ | {
19467
+ /** The ID of the action attempt. */
19468
+ action_attempt_id: string
19469
+ status: 'error'
19470
+ result: null
19471
+ action_type: 'SCAN_CARD'
17512
19472
  error: {
17513
19473
  type: 'no_card_on_encoder'
17514
19474
  message: string
@@ -18000,25 +19960,165 @@ export interface Routes {
18000
19960
  status: 'pending'
18001
19961
  result: null
18002
19962
  error: null
18003
- action_type: 'READ_CARD'
19963
+ action_type: 'SCAN_CARD'
18004
19964
  }
18005
19965
  | {
18006
19966
  /** The ID of the action attempt. */
18007
19967
  action_attempt_id: string
18008
19968
  status: 'success'
18009
19969
  error: null
18010
- action_type: 'READ_CARD'
19970
+ action_type: 'SCAN_CARD'
18011
19971
  result: {
18012
- /** A number or string that physically identifies this card. */
18013
- card_number: string | null
18014
- }
18015
- }
18016
- | {
18017
- /** The ID of the action attempt. */
18018
- action_attempt_id: string
18019
- status: 'error'
18020
- result: null
18021
- action_type: 'READ_CARD'
19972
+ /** Snapshot of the card data read from the physical encoder. */
19973
+ acs_credential_on_encoder: {
19974
+ /** Date and time the credential was created. */
19975
+ created_at: string
19976
+ is_issued: boolean | null
19977
+ /** Date and time the credential will become useable. */
19978
+ starts_at: string | null
19979
+ /** Date and time the credential will stop being useable. */
19980
+ ends_at: string | null
19981
+ /** A number or string that physically identifies this card. */
19982
+ card_number: string | null
19983
+ visionline_metadata?:
19984
+ | {
19985
+ card_id: string
19986
+ card_function_type: 'guest' | 'staff'
19987
+ cancelled: boolean
19988
+ discarded: boolean
19989
+ expired: boolean
19990
+ overwritten: boolean
19991
+ overridden?: boolean | undefined
19992
+ pending_auto_update: boolean
19993
+ card_format: 'TLCode' | 'rfid48'
19994
+ card_holder?: string | undefined
19995
+ number_of_issued_cards: number
19996
+ }
19997
+ | undefined
19998
+ }
19999
+ /** Matching acs_credential currently encoded on this card. */
20000
+ acs_credential_on_seam:
20001
+ | (
20002
+ | {
20003
+ acs_credential_id: string
20004
+ acs_user_id?: string | undefined
20005
+ acs_credential_pool_id?: string | undefined
20006
+ acs_system_id: string
20007
+ parent_acs_credential_id?: string | undefined
20008
+ display_name: string
20009
+ code?: (string | undefined) | null
20010
+ card_number?: (string | undefined) | null
20011
+ is_issued?: boolean | undefined
20012
+ issued_at?: (string | undefined) | null
20013
+ access_method: 'code' | 'card' | 'mobile_key'
20014
+ external_type?:
20015
+ | (
20016
+ | 'pti_card'
20017
+ | 'brivo_credential'
20018
+ | 'hid_credential'
20019
+ | 'visionline_card'
20020
+ | 'salto_ks_credential'
20021
+ )
20022
+ | undefined
20023
+ external_type_display_name?: string | undefined
20024
+ created_at: string
20025
+ workspace_id: string
20026
+ starts_at?: string | undefined
20027
+ ends_at?: string | undefined
20028
+ errors: Array<{
20029
+ error_code: string
20030
+ message: string
20031
+ }>
20032
+ warnings: Array<{
20033
+ warning_code: string
20034
+ message: string
20035
+ }>
20036
+ is_multi_phone_sync_credential?: boolean | undefined
20037
+ is_latest_desired_state_synced_with_provider?:
20038
+ | boolean
20039
+ | undefined
20040
+ latest_desired_state_synced_with_provider_at?:
20041
+ | string
20042
+ | undefined
20043
+ visionline_metadata?:
20044
+ | {
20045
+ card_function_type: 'guest' | 'staff'
20046
+ joiner_acs_credential_ids?: string[] | undefined
20047
+ guest_acs_entrance_ids?: string[] | undefined
20048
+ common_acs_entrance_ids?: string[] | undefined
20049
+ is_valid?: boolean | undefined
20050
+ auto_join?: boolean | undefined
20051
+ card_id?: string | undefined
20052
+ credential_id?: string | undefined
20053
+ }
20054
+ | undefined
20055
+ is_managed: true
20056
+ }
20057
+ | {
20058
+ acs_credential_id: string
20059
+ acs_user_id?: string | undefined
20060
+ acs_credential_pool_id?: string | undefined
20061
+ acs_system_id: string
20062
+ parent_acs_credential_id?: string | undefined
20063
+ display_name: string
20064
+ code?: (string | undefined) | null
20065
+ card_number?: (string | undefined) | null
20066
+ is_issued?: boolean | undefined
20067
+ issued_at?: (string | undefined) | null
20068
+ access_method: 'code' | 'card' | 'mobile_key'
20069
+ external_type?:
20070
+ | (
20071
+ | 'pti_card'
20072
+ | 'brivo_credential'
20073
+ | 'hid_credential'
20074
+ | 'visionline_card'
20075
+ | 'salto_ks_credential'
20076
+ )
20077
+ | undefined
20078
+ external_type_display_name?: string | undefined
20079
+ created_at: string
20080
+ workspace_id: string
20081
+ starts_at?: string | undefined
20082
+ ends_at?: string | undefined
20083
+ errors: Array<{
20084
+ error_code: string
20085
+ message: string
20086
+ }>
20087
+ warnings: Array<{
20088
+ warning_code: string
20089
+ message: string
20090
+ }>
20091
+ is_multi_phone_sync_credential?: boolean | undefined
20092
+ is_latest_desired_state_synced_with_provider?:
20093
+ | boolean
20094
+ | undefined
20095
+ latest_desired_state_synced_with_provider_at?:
20096
+ | string
20097
+ | undefined
20098
+ visionline_metadata?:
20099
+ | {
20100
+ card_function_type: 'guest' | 'staff'
20101
+ joiner_acs_credential_ids?: string[] | undefined
20102
+ guest_acs_entrance_ids?: string[] | undefined
20103
+ common_acs_entrance_ids?: string[] | undefined
20104
+ is_valid?: boolean | undefined
20105
+ auto_join?: boolean | undefined
20106
+ card_id?: string | undefined
20107
+ credential_id?: string | undefined
20108
+ }
20109
+ | undefined
20110
+ is_managed: false
20111
+ }
20112
+ )
20113
+ | null
20114
+ }
20115
+ }
20116
+ | {
20117
+ /** The ID of the action attempt. */
20118
+ action_attempt_id: string
20119
+ status: 'error'
20120
+ result: null
20121
+ action_type: 'SCAN_CARD'
18022
20122
  error: {
18023
20123
  type: 'no_card_on_encoder'
18024
20124
  message: string
@@ -19168,25 +21268,165 @@ export interface Routes {
19168
21268
  status: 'pending'
19169
21269
  result: null
19170
21270
  error: null
19171
- action_type: 'READ_CARD'
21271
+ action_type: 'SCAN_CARD'
19172
21272
  }
19173
21273
  | {
19174
21274
  /** The ID of the action attempt. */
19175
21275
  action_attempt_id: string
19176
21276
  status: 'success'
19177
21277
  error: null
19178
- action_type: 'READ_CARD'
21278
+ action_type: 'SCAN_CARD'
19179
21279
  result: {
19180
- /** A number or string that physically identifies this card. */
19181
- card_number: string | null
19182
- }
19183
- }
19184
- | {
19185
- /** The ID of the action attempt. */
19186
- action_attempt_id: string
19187
- status: 'error'
19188
- result: null
19189
- action_type: 'READ_CARD'
21280
+ /** Snapshot of the card data read from the physical encoder. */
21281
+ acs_credential_on_encoder: {
21282
+ /** Date and time the credential was created. */
21283
+ created_at: string
21284
+ is_issued: boolean | null
21285
+ /** Date and time the credential will become useable. */
21286
+ starts_at: string | null
21287
+ /** Date and time the credential will stop being useable. */
21288
+ ends_at: string | null
21289
+ /** A number or string that physically identifies this card. */
21290
+ card_number: string | null
21291
+ visionline_metadata?:
21292
+ | {
21293
+ card_id: string
21294
+ card_function_type: 'guest' | 'staff'
21295
+ cancelled: boolean
21296
+ discarded: boolean
21297
+ expired: boolean
21298
+ overwritten: boolean
21299
+ overridden?: boolean | undefined
21300
+ pending_auto_update: boolean
21301
+ card_format: 'TLCode' | 'rfid48'
21302
+ card_holder?: string | undefined
21303
+ number_of_issued_cards: number
21304
+ }
21305
+ | undefined
21306
+ }
21307
+ /** Matching acs_credential currently encoded on this card. */
21308
+ acs_credential_on_seam:
21309
+ | (
21310
+ | {
21311
+ acs_credential_id: string
21312
+ acs_user_id?: string | undefined
21313
+ acs_credential_pool_id?: string | undefined
21314
+ acs_system_id: string
21315
+ parent_acs_credential_id?: string | undefined
21316
+ display_name: string
21317
+ code?: (string | undefined) | null
21318
+ card_number?: (string | undefined) | null
21319
+ is_issued?: boolean | undefined
21320
+ issued_at?: (string | undefined) | null
21321
+ access_method: 'code' | 'card' | 'mobile_key'
21322
+ external_type?:
21323
+ | (
21324
+ | 'pti_card'
21325
+ | 'brivo_credential'
21326
+ | 'hid_credential'
21327
+ | 'visionline_card'
21328
+ | 'salto_ks_credential'
21329
+ )
21330
+ | undefined
21331
+ external_type_display_name?: string | undefined
21332
+ created_at: string
21333
+ workspace_id: string
21334
+ starts_at?: string | undefined
21335
+ ends_at?: string | undefined
21336
+ errors: Array<{
21337
+ error_code: string
21338
+ message: string
21339
+ }>
21340
+ warnings: Array<{
21341
+ warning_code: string
21342
+ message: string
21343
+ }>
21344
+ is_multi_phone_sync_credential?: boolean | undefined
21345
+ is_latest_desired_state_synced_with_provider?:
21346
+ | boolean
21347
+ | undefined
21348
+ latest_desired_state_synced_with_provider_at?:
21349
+ | string
21350
+ | undefined
21351
+ visionline_metadata?:
21352
+ | {
21353
+ card_function_type: 'guest' | 'staff'
21354
+ joiner_acs_credential_ids?: string[] | undefined
21355
+ guest_acs_entrance_ids?: string[] | undefined
21356
+ common_acs_entrance_ids?: string[] | undefined
21357
+ is_valid?: boolean | undefined
21358
+ auto_join?: boolean | undefined
21359
+ card_id?: string | undefined
21360
+ credential_id?: string | undefined
21361
+ }
21362
+ | undefined
21363
+ is_managed: true
21364
+ }
21365
+ | {
21366
+ acs_credential_id: string
21367
+ acs_user_id?: string | undefined
21368
+ acs_credential_pool_id?: string | undefined
21369
+ acs_system_id: string
21370
+ parent_acs_credential_id?: string | undefined
21371
+ display_name: string
21372
+ code?: (string | undefined) | null
21373
+ card_number?: (string | undefined) | null
21374
+ is_issued?: boolean | undefined
21375
+ issued_at?: (string | undefined) | null
21376
+ access_method: 'code' | 'card' | 'mobile_key'
21377
+ external_type?:
21378
+ | (
21379
+ | 'pti_card'
21380
+ | 'brivo_credential'
21381
+ | 'hid_credential'
21382
+ | 'visionline_card'
21383
+ | 'salto_ks_credential'
21384
+ )
21385
+ | undefined
21386
+ external_type_display_name?: string | undefined
21387
+ created_at: string
21388
+ workspace_id: string
21389
+ starts_at?: string | undefined
21390
+ ends_at?: string | undefined
21391
+ errors: Array<{
21392
+ error_code: string
21393
+ message: string
21394
+ }>
21395
+ warnings: Array<{
21396
+ warning_code: string
21397
+ message: string
21398
+ }>
21399
+ is_multi_phone_sync_credential?: boolean | undefined
21400
+ is_latest_desired_state_synced_with_provider?:
21401
+ | boolean
21402
+ | undefined
21403
+ latest_desired_state_synced_with_provider_at?:
21404
+ | string
21405
+ | undefined
21406
+ visionline_metadata?:
21407
+ | {
21408
+ card_function_type: 'guest' | 'staff'
21409
+ joiner_acs_credential_ids?: string[] | undefined
21410
+ guest_acs_entrance_ids?: string[] | undefined
21411
+ common_acs_entrance_ids?: string[] | undefined
21412
+ is_valid?: boolean | undefined
21413
+ auto_join?: boolean | undefined
21414
+ card_id?: string | undefined
21415
+ credential_id?: string | undefined
21416
+ }
21417
+ | undefined
21418
+ is_managed: false
21419
+ }
21420
+ )
21421
+ | null
21422
+ }
21423
+ }
21424
+ | {
21425
+ /** The ID of the action attempt. */
21426
+ action_attempt_id: string
21427
+ status: 'error'
21428
+ result: null
21429
+ action_type: 'SCAN_CARD'
19190
21430
  error: {
19191
21431
  type: 'no_card_on_encoder'
19192
21432
  message: string
@@ -19680,25 +21920,165 @@ export interface Routes {
19680
21920
  status: 'pending'
19681
21921
  result: null
19682
21922
  error: null
19683
- action_type: 'READ_CARD'
21923
+ action_type: 'SCAN_CARD'
19684
21924
  }
19685
21925
  | {
19686
21926
  /** The ID of the action attempt. */
19687
21927
  action_attempt_id: string
19688
21928
  status: 'success'
19689
21929
  error: null
19690
- action_type: 'READ_CARD'
21930
+ action_type: 'SCAN_CARD'
19691
21931
  result: {
19692
- /** A number or string that physically identifies this card. */
19693
- card_number: string | null
19694
- }
19695
- }
19696
- | {
19697
- /** The ID of the action attempt. */
19698
- action_attempt_id: string
19699
- status: 'error'
19700
- result: null
19701
- action_type: 'READ_CARD'
21932
+ /** Snapshot of the card data read from the physical encoder. */
21933
+ acs_credential_on_encoder: {
21934
+ /** Date and time the credential was created. */
21935
+ created_at: string
21936
+ is_issued: boolean | null
21937
+ /** Date and time the credential will become useable. */
21938
+ starts_at: string | null
21939
+ /** Date and time the credential will stop being useable. */
21940
+ ends_at: string | null
21941
+ /** A number or string that physically identifies this card. */
21942
+ card_number: string | null
21943
+ visionline_metadata?:
21944
+ | {
21945
+ card_id: string
21946
+ card_function_type: 'guest' | 'staff'
21947
+ cancelled: boolean
21948
+ discarded: boolean
21949
+ expired: boolean
21950
+ overwritten: boolean
21951
+ overridden?: boolean | undefined
21952
+ pending_auto_update: boolean
21953
+ card_format: 'TLCode' | 'rfid48'
21954
+ card_holder?: string | undefined
21955
+ number_of_issued_cards: number
21956
+ }
21957
+ | undefined
21958
+ }
21959
+ /** Matching acs_credential currently encoded on this card. */
21960
+ acs_credential_on_seam:
21961
+ | (
21962
+ | {
21963
+ acs_credential_id: string
21964
+ acs_user_id?: string | undefined
21965
+ acs_credential_pool_id?: string | undefined
21966
+ acs_system_id: string
21967
+ parent_acs_credential_id?: string | undefined
21968
+ display_name: string
21969
+ code?: (string | undefined) | null
21970
+ card_number?: (string | undefined) | null
21971
+ is_issued?: boolean | undefined
21972
+ issued_at?: (string | undefined) | null
21973
+ access_method: 'code' | 'card' | 'mobile_key'
21974
+ external_type?:
21975
+ | (
21976
+ | 'pti_card'
21977
+ | 'brivo_credential'
21978
+ | 'hid_credential'
21979
+ | 'visionline_card'
21980
+ | 'salto_ks_credential'
21981
+ )
21982
+ | undefined
21983
+ external_type_display_name?: string | undefined
21984
+ created_at: string
21985
+ workspace_id: string
21986
+ starts_at?: string | undefined
21987
+ ends_at?: string | undefined
21988
+ errors: Array<{
21989
+ error_code: string
21990
+ message: string
21991
+ }>
21992
+ warnings: Array<{
21993
+ warning_code: string
21994
+ message: string
21995
+ }>
21996
+ is_multi_phone_sync_credential?: boolean | undefined
21997
+ is_latest_desired_state_synced_with_provider?:
21998
+ | boolean
21999
+ | undefined
22000
+ latest_desired_state_synced_with_provider_at?:
22001
+ | string
22002
+ | undefined
22003
+ visionline_metadata?:
22004
+ | {
22005
+ card_function_type: 'guest' | 'staff'
22006
+ joiner_acs_credential_ids?: string[] | undefined
22007
+ guest_acs_entrance_ids?: string[] | undefined
22008
+ common_acs_entrance_ids?: string[] | undefined
22009
+ is_valid?: boolean | undefined
22010
+ auto_join?: boolean | undefined
22011
+ card_id?: string | undefined
22012
+ credential_id?: string | undefined
22013
+ }
22014
+ | undefined
22015
+ is_managed: true
22016
+ }
22017
+ | {
22018
+ acs_credential_id: string
22019
+ acs_user_id?: string | undefined
22020
+ acs_credential_pool_id?: string | undefined
22021
+ acs_system_id: string
22022
+ parent_acs_credential_id?: string | undefined
22023
+ display_name: string
22024
+ code?: (string | undefined) | null
22025
+ card_number?: (string | undefined) | null
22026
+ is_issued?: boolean | undefined
22027
+ issued_at?: (string | undefined) | null
22028
+ access_method: 'code' | 'card' | 'mobile_key'
22029
+ external_type?:
22030
+ | (
22031
+ | 'pti_card'
22032
+ | 'brivo_credential'
22033
+ | 'hid_credential'
22034
+ | 'visionline_card'
22035
+ | 'salto_ks_credential'
22036
+ )
22037
+ | undefined
22038
+ external_type_display_name?: string | undefined
22039
+ created_at: string
22040
+ workspace_id: string
22041
+ starts_at?: string | undefined
22042
+ ends_at?: string | undefined
22043
+ errors: Array<{
22044
+ error_code: string
22045
+ message: string
22046
+ }>
22047
+ warnings: Array<{
22048
+ warning_code: string
22049
+ message: string
22050
+ }>
22051
+ is_multi_phone_sync_credential?: boolean | undefined
22052
+ is_latest_desired_state_synced_with_provider?:
22053
+ | boolean
22054
+ | undefined
22055
+ latest_desired_state_synced_with_provider_at?:
22056
+ | string
22057
+ | undefined
22058
+ visionline_metadata?:
22059
+ | {
22060
+ card_function_type: 'guest' | 'staff'
22061
+ joiner_acs_credential_ids?: string[] | undefined
22062
+ guest_acs_entrance_ids?: string[] | undefined
22063
+ common_acs_entrance_ids?: string[] | undefined
22064
+ is_valid?: boolean | undefined
22065
+ auto_join?: boolean | undefined
22066
+ card_id?: string | undefined
22067
+ credential_id?: string | undefined
22068
+ }
22069
+ | undefined
22070
+ is_managed: false
22071
+ }
22072
+ )
22073
+ | null
22074
+ }
22075
+ }
22076
+ | {
22077
+ /** The ID of the action attempt. */
22078
+ action_attempt_id: string
22079
+ status: 'error'
22080
+ result: null
22081
+ action_type: 'SCAN_CARD'
19702
22082
  error: {
19703
22083
  type: 'no_card_on_encoder'
19704
22084
  message: string
@@ -20898,24 +23278,637 @@ export interface Routes {
20898
23278
  can_simulate_connection?: boolean | undefined
20899
23279
  can_simulate_disconnection?: boolean | undefined
20900
23280
  }>
20901
- }
20902
- }
20903
- '/thermostats/off': {
20904
- route: '/thermostats/off'
20905
- method: 'POST'
20906
- queryParams: {}
20907
- jsonBody: {
20908
- device_id: string
20909
- sync?: boolean
20910
- }
20911
- commonParams: {}
20912
- formData: {}
20913
- jsonResponse: {
20914
- action_attempt:
20915
- | {
20916
- /** The ID of the action attempt. */
20917
- action_attempt_id: string
20918
- status: 'pending'
23281
+ devices: Array<{
23282
+ /** Unique identifier for the device. */
23283
+ device_id: string
23284
+ /** Type of the device. */
23285
+ device_type:
23286
+ | (
23287
+ | 'akuvox_lock'
23288
+ | 'august_lock'
23289
+ | 'brivo_access_point'
23290
+ | 'butterflymx_panel'
23291
+ | 'avigilon_alta_entry'
23292
+ | 'doorking_lock'
23293
+ | 'genie_door'
23294
+ | 'igloo_lock'
23295
+ | 'linear_lock'
23296
+ | 'lockly_lock'
23297
+ | 'kwikset_lock'
23298
+ | 'nuki_lock'
23299
+ | 'salto_lock'
23300
+ | 'schlage_lock'
23301
+ | 'seam_relay'
23302
+ | 'smartthings_lock'
23303
+ | 'wyze_lock'
23304
+ | 'yale_lock'
23305
+ | 'two_n_intercom'
23306
+ | 'controlbyweb_device'
23307
+ | 'ttlock_lock'
23308
+ | 'igloohome_lock'
23309
+ | 'hubitat_lock'
23310
+ | 'four_suites_door'
23311
+ | 'dormakaba_oracode_door'
23312
+ | 'tedee_lock'
23313
+ | 'akiles_lock'
23314
+ )
23315
+ | ('noiseaware_activity_zone' | 'minut_sensor')
23316
+ | (
23317
+ | 'ecobee_thermostat'
23318
+ | 'nest_thermostat'
23319
+ | 'honeywell_resideo_thermostat'
23320
+ )
23321
+ | ('ios_phone' | 'android_phone')
23322
+ | 'visionline_encoder'
23323
+ /** Optional nickname to describe the device, settable through Seam */
23324
+ nickname?: string | undefined
23325
+ /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
23326
+ display_name: string
23327
+ /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
23328
+ capabilities_supported: Array<
23329
+ | 'access_code'
23330
+ | 'lock'
23331
+ | 'noise_detection'
23332
+ | 'thermostat'
23333
+ | 'battery'
23334
+ | 'phone'
23335
+ >
23336
+ /** Properties of the device. */
23337
+ properties: (({
23338
+ /** Indicates whether the device is online. */
23339
+ online: boolean
23340
+ /** Name of the device.
23341
+ * @deprecated use device.display_name instead */
23342
+ name: string
23343
+ /** Represents the accessory keypad state. */
23344
+ accessory_keypad?:
23345
+ | {
23346
+ /** Indicates if the accessory_keypad is connected to the device. */
23347
+ is_connected: boolean
23348
+ /** Indicates if the keypad battery properties. */
23349
+ battery?:
23350
+ | {
23351
+ level: number
23352
+ }
23353
+ | undefined
23354
+ }
23355
+ | undefined
23356
+ appearance: {
23357
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
23358
+ name: string
23359
+ }
23360
+ model: {
23361
+ /** Indicates whether the device can connect a accessory keypad. */
23362
+ can_connect_accessory_keypad?: boolean | undefined
23363
+ /** Display name of the device model. */
23364
+ display_name: string
23365
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
23366
+ manufacturer_display_name: string
23367
+ /** Indicates whether the device has a built in accessory keypad. */
23368
+ has_built_in_keypad?: boolean | undefined
23369
+ /** Indicates whether the device supports offline access codes. */
23370
+ offline_access_codes_supported?: boolean | undefined
23371
+ /** Indicates whether the device supports online access codes. */
23372
+ online_access_codes_supported?: boolean | undefined
23373
+ /**
23374
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
23375
+ accessory_keypad_supported?: boolean | undefined
23376
+ }
23377
+ /** Indicates whether the device has direct power. */
23378
+ has_direct_power?: boolean | undefined
23379
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
23380
+ battery_level?: number | undefined
23381
+ /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
23382
+ battery?:
23383
+ | {
23384
+ level: number
23385
+ status: 'critical' | 'low' | 'good' | 'full'
23386
+ }
23387
+ | undefined
23388
+ /** Manufacturer of the device. */
23389
+ manufacturer?: string | undefined
23390
+ /** Image URL for the device. */
23391
+ image_url?: string | undefined
23392
+ /** Alt text for the device image. */
23393
+ image_alt_text?: string | undefined
23394
+ /** Serial number of the device. */
23395
+ serial_number?: string | undefined
23396
+ /** Indicates whether it is currently possible to use online access codes for the device. */
23397
+ online_access_codes_enabled?: boolean | undefined
23398
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
23399
+ offline_access_codes_enabled?: boolean | undefined
23400
+ /**
23401
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
23402
+ supports_accessory_keypad?: boolean | undefined
23403
+ /**
23404
+ * @deprecated use offline_access_codes_enabled */
23405
+ supports_offline_access_codes?: boolean | undefined
23406
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
23407
+ noise_level_decibels?: number | undefined
23408
+ /** Array of noise threshold IDs that are currently triggering. */
23409
+ currently_triggering_noise_threshold_ids?: string[] | undefined
23410
+ } & {
23411
+ assa_abloy_credential_service_metadata?:
23412
+ | (
23413
+ | {
23414
+ has_active_endpoint: boolean
23415
+ endpoints: Array<{
23416
+ endpoint_id: string
23417
+ is_active: boolean
23418
+ }>
23419
+ }
23420
+ | undefined
23421
+ )
23422
+ | undefined
23423
+ }) & {
23424
+ august_metadata?:
23425
+ | {
23426
+ lock_id: string
23427
+ lock_name: string
23428
+ house_name: string
23429
+ has_keypad: boolean
23430
+ keypad_battery_level?: string | undefined
23431
+ model?: string | undefined
23432
+ house_id?: string | undefined
23433
+ }
23434
+ | undefined
23435
+ avigilon_alta_metadata?:
23436
+ | {
23437
+ entry_name: string
23438
+ org_name: string
23439
+ zone_id: number
23440
+ zone_name: string
23441
+ site_id: number
23442
+ site_name: string
23443
+ entry_relays_total_count: number
23444
+ }
23445
+ | undefined
23446
+ schlage_metadata?:
23447
+ | {
23448
+ device_id: string
23449
+ device_name: string
23450
+ access_code_length: number | null
23451
+ model?: string | undefined
23452
+ }
23453
+ | undefined
23454
+ smartthings_metadata?:
23455
+ | {
23456
+ device_id: string
23457
+ device_name: string
23458
+ model?: string | undefined
23459
+ location_id?: string | undefined
23460
+ }
23461
+ | undefined
23462
+ lockly_metadata?:
23463
+ | {
23464
+ device_id: string
23465
+ device_name: string
23466
+ model?: string | undefined
23467
+ }
23468
+ | undefined
23469
+ nuki_metadata?:
23470
+ | {
23471
+ device_id: string
23472
+ device_name: string
23473
+ keypad_battery_critical?: boolean | undefined
23474
+ keypad_paired?: boolean | undefined
23475
+ keypad_2_paired?: boolean | undefined
23476
+ }
23477
+ | undefined
23478
+ kwikset_metadata?:
23479
+ | {
23480
+ device_id: string
23481
+ device_name: string
23482
+ model_number: string
23483
+ }
23484
+ | undefined
23485
+ salto_metadata?:
23486
+ | {
23487
+ lock_id: string
23488
+ customer_reference: string
23489
+ lock_type: string
23490
+ battery_level: string
23491
+ locked_state: string
23492
+ model?: string | undefined
23493
+ }
23494
+ | undefined
23495
+ genie_metadata?:
23496
+ | {
23497
+ device_name: string
23498
+ door_name: string
23499
+ }
23500
+ | undefined
23501
+ brivo_metadata?:
23502
+ | {
23503
+ device_name: string
23504
+ }
23505
+ | undefined
23506
+ igloo_metadata?:
23507
+ | {
23508
+ device_id: string
23509
+ bridge_id: string
23510
+ model?: string | undefined
23511
+ }
23512
+ | undefined
23513
+ noiseaware_metadata?:
23514
+ | {
23515
+ device_model: 'indoor' | 'outdoor'
23516
+ noise_level_nrs: number
23517
+ noise_level_decibel: number
23518
+ device_name: string
23519
+ device_id: string
23520
+ }
23521
+ | undefined
23522
+ minut_metadata?:
23523
+ | {
23524
+ device_id: string
23525
+ device_name: string
23526
+ latest_sensor_values: {
23527
+ temperature: {
23528
+ time: string
23529
+ value: number
23530
+ }
23531
+ sound: {
23532
+ time: string
23533
+ value: number
23534
+ }
23535
+ humidity: {
23536
+ time: string
23537
+ value: number
23538
+ }
23539
+ pressure: {
23540
+ time: string
23541
+ value: number
23542
+ }
23543
+ accelerometer_z: {
23544
+ time: string
23545
+ value: number
23546
+ }
23547
+ }
23548
+ }
23549
+ | undefined
23550
+ four_suites_metadata?:
23551
+ | {
23552
+ device_id: number
23553
+ device_name: string
23554
+ reclose_delay_in_seconds: number
23555
+ }
23556
+ | undefined
23557
+ two_n_metadata?:
23558
+ | {
23559
+ device_id: number
23560
+ device_name: string
23561
+ }
23562
+ | undefined
23563
+ controlbyweb_metadata?:
23564
+ | {
23565
+ device_id: string
23566
+ device_name: string
23567
+ relay_name: string | null
23568
+ }
23569
+ | undefined
23570
+ ttlock_metadata?:
23571
+ | {
23572
+ lock_id: number
23573
+ lock_alias: string
23574
+ feature_value: string
23575
+ features: {
23576
+ passcode: boolean
23577
+ passcode_management: boolean
23578
+ unlock_via_gateway: boolean
23579
+ lock_command: boolean
23580
+ incomplete_keyboard_passcode: boolean
23581
+ }
23582
+ has_gateway?: boolean | undefined
23583
+ wireless_keypads?:
23584
+ | Array<{
23585
+ wireless_keypad_id: number
23586
+ wireless_keypad_name: string
23587
+ }>
23588
+ | undefined
23589
+ }
23590
+ | undefined
23591
+ seam_bridge_metadata?:
23592
+ | {
23593
+ unlock_method?: ('bridge' | 'doorking') | undefined
23594
+ device_num: number
23595
+ name: string
23596
+ }
23597
+ | undefined
23598
+ igloohome_metadata?:
23599
+ | {
23600
+ device_id: string
23601
+ device_name: string
23602
+ bridge_id?: string | undefined
23603
+ bridge_name?: string | undefined
23604
+ keypad_id?: string | undefined
23605
+ }
23606
+ | undefined
23607
+ nest_metadata?:
23608
+ | {
23609
+ nest_device_id: string
23610
+ device_name: string
23611
+ custom_name: string
23612
+ }
23613
+ | undefined
23614
+ ecobee_metadata?:
23615
+ | {
23616
+ ecobee_device_id: string
23617
+ device_name: string
23618
+ }
23619
+ | undefined
23620
+ honeywell_resideo_metadata?:
23621
+ | {
23622
+ honeywell_resideo_device_id: string
23623
+ device_name: string
23624
+ }
23625
+ | undefined
23626
+ hubitat_metadata?:
23627
+ | {
23628
+ device_id: string
23629
+ device_name: string
23630
+ device_label: string
23631
+ }
23632
+ | undefined
23633
+ dormakaba_oracode_metadata?:
23634
+ | {
23635
+ door_id?: number | undefined
23636
+ door_name: string
23637
+ device_id?: (number | string) | undefined
23638
+ door_is_wireless: boolean
23639
+ /** @DEPRECATED */
23640
+ site_id: number | null
23641
+ site_name: string
23642
+ iana_timezone?: string | undefined
23643
+ predefined_time_slots?:
23644
+ | Array<{
23645
+ name: string
23646
+ prefix: number
23647
+ check_in_time: string
23648
+ check_out_time: string
23649
+ is_24_hour: boolean
23650
+ is_biweekly_mode: boolean
23651
+ is_one_shot: boolean
23652
+ is_master: boolean
23653
+ ext_dormakaba_oracode_user_level_prefix: number
23654
+ dormakaba_oracode_user_level_id: string
23655
+ }>
23656
+ | undefined
23657
+ }
23658
+ | undefined
23659
+ wyze_metadata?:
23660
+ | {
23661
+ device_id: string
23662
+ device_name: string
23663
+ product_name: string
23664
+ product_type: string
23665
+ product_model: string
23666
+ device_info_model: string
23667
+ keypad_uuid?: string | undefined
23668
+ locker_status_hardlock?: number | undefined
23669
+ }
23670
+ | undefined
23671
+ tedee_metadata?:
23672
+ | {
23673
+ device_id: number
23674
+ serial_number: string
23675
+ device_name: string
23676
+ device_model: string
23677
+ bridge_id: number
23678
+ bridge_name: string
23679
+ keypad_id?: number | undefined
23680
+ }
23681
+ | undefined
23682
+ visionline_metadata?:
23683
+ | {
23684
+ encoder_id: string
23685
+ }
23686
+ | undefined
23687
+ akiles_metadata?:
23688
+ | {
23689
+ gadget_name: string
23690
+ gadget_id: string
23691
+ }
23692
+ | undefined
23693
+ }) &
23694
+ ({
23695
+ _experimental_supported_code_from_access_codes_lengths?:
23696
+ | (number[] | undefined)
23697
+ | undefined
23698
+ code_constraints?:
23699
+ | (
23700
+ | Array<
23701
+ | {
23702
+ constraint_type:
23703
+ | 'no_zeros'
23704
+ | 'cannot_start_with_12'
23705
+ | 'no_triple_consecutive_ints'
23706
+ | 'cannot_specify_pin_code'
23707
+ | 'pin_code_matches_existing_set'
23708
+ | 'start_date_in_future'
23709
+ | 'no_ascending_or_descending_sequence'
23710
+ | 'at_least_three_unique_digits'
23711
+ | 'cannot_contain_089'
23712
+ | 'cannot_contain_0789'
23713
+ }
23714
+ | {
23715
+ constraint_type: 'name_length' | 'name_must_be_unique'
23716
+ min_length?: number | undefined
23717
+ max_length?: number | undefined
23718
+ }
23719
+ >
23720
+ | undefined
23721
+ )
23722
+ | undefined
23723
+ supported_code_lengths?: (number[] | undefined) | undefined
23724
+ max_active_codes_supported?: (number | undefined) | undefined
23725
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
23726
+ has_native_entry_events?: (boolean | undefined) | undefined
23727
+ locked?: (boolean | undefined) | undefined
23728
+ keypad_battery?:
23729
+ | (
23730
+ | {
23731
+ level: number
23732
+ }
23733
+ | undefined
23734
+ )
23735
+ | undefined
23736
+ door_open?: (boolean | undefined) | undefined
23737
+ } & {
23738
+ temperature_fahrenheit?: number | undefined
23739
+ temperature_celsius?: number | undefined
23740
+ relative_humidity?: number | undefined
23741
+ available_hvac_mode_settings?:
23742
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
23743
+ | undefined
23744
+ available_fan_mode_settings?:
23745
+ | Array<'auto' | 'on' | 'circulate'>
23746
+ | undefined
23747
+ is_heating?: boolean | undefined
23748
+ is_cooling?: boolean | undefined
23749
+ is_fan_running?: boolean | undefined
23750
+ /**
23751
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
23752
+ fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
23753
+ is_temporary_manual_override_active?: boolean | undefined
23754
+ current_climate_setting?:
23755
+ | {
23756
+ climate_preset_key?: string | undefined
23757
+ can_edit?: boolean | undefined
23758
+ can_delete?: boolean | undefined
23759
+ name?: ((string | null) | undefined) | undefined
23760
+ display_name?: string | undefined
23761
+ fan_mode_setting?:
23762
+ | (('auto' | 'on' | 'circulate') | undefined)
23763
+ | undefined
23764
+ hvac_mode_setting?:
23765
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
23766
+ | undefined
23767
+ cooling_set_point_celsius?: (number | undefined) | undefined
23768
+ heating_set_point_celsius?: (number | undefined) | undefined
23769
+ cooling_set_point_fahrenheit?:
23770
+ | (number | undefined)
23771
+ | undefined
23772
+ heating_set_point_fahrenheit?:
23773
+ | (number | undefined)
23774
+ | undefined
23775
+ manual_override_allowed?: boolean | undefined
23776
+ }
23777
+ | undefined
23778
+ /**
23779
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
23780
+ default_climate_setting?:
23781
+ | {
23782
+ climate_preset_key?: string | undefined
23783
+ can_edit?: boolean | undefined
23784
+ can_delete?: boolean | undefined
23785
+ name?: ((string | null) | undefined) | undefined
23786
+ display_name?: string | undefined
23787
+ fan_mode_setting?:
23788
+ | (('auto' | 'on' | 'circulate') | undefined)
23789
+ | undefined
23790
+ hvac_mode_setting?:
23791
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
23792
+ | undefined
23793
+ cooling_set_point_celsius?: (number | undefined) | undefined
23794
+ heating_set_point_celsius?: (number | undefined) | undefined
23795
+ cooling_set_point_fahrenheit?:
23796
+ | (number | undefined)
23797
+ | undefined
23798
+ heating_set_point_fahrenheit?:
23799
+ | (number | undefined)
23800
+ | undefined
23801
+ manual_override_allowed?: boolean | undefined
23802
+ }
23803
+ | undefined
23804
+ available_climate_presets?:
23805
+ | Array<{
23806
+ climate_preset_key: string
23807
+ can_edit: boolean
23808
+ can_delete: boolean
23809
+ name?: (string | null) | undefined
23810
+ display_name: string
23811
+ fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
23812
+ hvac_mode_setting?:
23813
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
23814
+ | undefined
23815
+ cooling_set_point_celsius?: number | undefined
23816
+ heating_set_point_celsius?: number | undefined
23817
+ cooling_set_point_fahrenheit?: number | undefined
23818
+ heating_set_point_fahrenheit?: number | undefined
23819
+ manual_override_allowed: boolean
23820
+ }>
23821
+ | undefined
23822
+ fallback_climate_preset_key?: (string | null) | undefined
23823
+ active_thermostat_schedule?:
23824
+ | ({
23825
+ thermostat_schedule_id: string
23826
+ device_id: string
23827
+ name?: string | undefined
23828
+ climate_preset_key: string
23829
+ max_override_period_minutes: number
23830
+ starts_at: string
23831
+ ends_at: string
23832
+ created_at: string
23833
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
23834
+ errors?: any
23835
+ } | null)
23836
+ | undefined
23837
+ min_cooling_set_point_celsius?: number | undefined
23838
+ min_cooling_set_point_fahrenheit?: number | undefined
23839
+ max_cooling_set_point_celsius?: number | undefined
23840
+ max_cooling_set_point_fahrenheit?: number | undefined
23841
+ min_heating_set_point_celsius?: number | undefined
23842
+ min_heating_set_point_fahrenheit?: number | undefined
23843
+ max_heating_set_point_celsius?: number | undefined
23844
+ max_heating_set_point_fahrenheit?: number | undefined
23845
+ min_heating_cooling_delta_celsius?: number | undefined
23846
+ min_heating_cooling_delta_fahrenheit?: number | undefined
23847
+ })
23848
+ /** Location information for the device. */
23849
+ location: {
23850
+ /** Name of the device location. */
23851
+ location_name?: string | undefined
23852
+ /** Time zone of the device location. */
23853
+ timezone?: string | undefined
23854
+ } | null
23855
+ /** Unique identifier for the account associated with the device. */
23856
+ connected_account_id: string
23857
+ /** Unique identifier for the Seam workspace associated with the device. */
23858
+ workspace_id: string
23859
+ /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
23860
+ errors: Array<
23861
+ | {
23862
+ message: string
23863
+ is_device_error: true
23864
+ error_code: string
23865
+ }
23866
+ | {
23867
+ message: string
23868
+ is_connected_account_error: true
23869
+ error_code: string
23870
+ }
23871
+ >
23872
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
23873
+ warnings: Array<{
23874
+ message: string
23875
+ warning_code: string
23876
+ }>
23877
+ /** Date and time at which the device object was created. */
23878
+ created_at: string
23879
+ /** Indicates whether Seam manages the device. */
23880
+ is_managed: true
23881
+ custom_metadata: Record<string, string | boolean>
23882
+ can_remotely_unlock?: boolean | undefined
23883
+ can_remotely_lock?: boolean | undefined
23884
+ can_program_offline_access_codes?: boolean | undefined
23885
+ can_program_online_access_codes?: boolean | undefined
23886
+ can_hvac_heat?: boolean | undefined
23887
+ can_hvac_cool?: boolean | undefined
23888
+ can_hvac_heat_cool?: boolean | undefined
23889
+ can_turn_off_hvac?: boolean | undefined
23890
+ can_simulate_removal?: boolean | undefined
23891
+ can_simulate_connection?: boolean | undefined
23892
+ can_simulate_disconnection?: boolean | undefined
23893
+ }>
23894
+ }
23895
+ }
23896
+ '/thermostats/off': {
23897
+ route: '/thermostats/off'
23898
+ method: 'POST'
23899
+ queryParams: {}
23900
+ jsonBody: {
23901
+ device_id: string
23902
+ sync?: boolean
23903
+ }
23904
+ commonParams: {}
23905
+ formData: {}
23906
+ jsonResponse: {
23907
+ action_attempt:
23908
+ | {
23909
+ /** The ID of the action attempt. */
23910
+ action_attempt_id: string
23911
+ status: 'pending'
20919
23912
  result: null
20920
23913
  error: null
20921
23914
  action_type: 'LOCK_DOOR'
@@ -20972,25 +23965,165 @@ export interface Routes {
20972
23965
  status: 'pending'
20973
23966
  result: null
20974
23967
  error: null
20975
- action_type: 'READ_CARD'
23968
+ action_type: 'SCAN_CARD'
20976
23969
  }
20977
23970
  | {
20978
23971
  /** The ID of the action attempt. */
20979
23972
  action_attempt_id: string
20980
23973
  status: 'success'
20981
23974
  error: null
20982
- action_type: 'READ_CARD'
23975
+ action_type: 'SCAN_CARD'
20983
23976
  result: {
20984
- /** A number or string that physically identifies this card. */
20985
- card_number: string | null
20986
- }
20987
- }
20988
- | {
20989
- /** The ID of the action attempt. */
20990
- action_attempt_id: string
20991
- status: 'error'
20992
- result: null
20993
- action_type: 'READ_CARD'
23977
+ /** Snapshot of the card data read from the physical encoder. */
23978
+ acs_credential_on_encoder: {
23979
+ /** Date and time the credential was created. */
23980
+ created_at: string
23981
+ is_issued: boolean | null
23982
+ /** Date and time the credential will become useable. */
23983
+ starts_at: string | null
23984
+ /** Date and time the credential will stop being useable. */
23985
+ ends_at: string | null
23986
+ /** A number or string that physically identifies this card. */
23987
+ card_number: string | null
23988
+ visionline_metadata?:
23989
+ | {
23990
+ card_id: string
23991
+ card_function_type: 'guest' | 'staff'
23992
+ cancelled: boolean
23993
+ discarded: boolean
23994
+ expired: boolean
23995
+ overwritten: boolean
23996
+ overridden?: boolean | undefined
23997
+ pending_auto_update: boolean
23998
+ card_format: 'TLCode' | 'rfid48'
23999
+ card_holder?: string | undefined
24000
+ number_of_issued_cards: number
24001
+ }
24002
+ | undefined
24003
+ }
24004
+ /** Matching acs_credential currently encoded on this card. */
24005
+ acs_credential_on_seam:
24006
+ | (
24007
+ | {
24008
+ acs_credential_id: string
24009
+ acs_user_id?: string | undefined
24010
+ acs_credential_pool_id?: string | undefined
24011
+ acs_system_id: string
24012
+ parent_acs_credential_id?: string | undefined
24013
+ display_name: string
24014
+ code?: (string | undefined) | null
24015
+ card_number?: (string | undefined) | null
24016
+ is_issued?: boolean | undefined
24017
+ issued_at?: (string | undefined) | null
24018
+ access_method: 'code' | 'card' | 'mobile_key'
24019
+ external_type?:
24020
+ | (
24021
+ | 'pti_card'
24022
+ | 'brivo_credential'
24023
+ | 'hid_credential'
24024
+ | 'visionline_card'
24025
+ | 'salto_ks_credential'
24026
+ )
24027
+ | undefined
24028
+ external_type_display_name?: string | undefined
24029
+ created_at: string
24030
+ workspace_id: string
24031
+ starts_at?: string | undefined
24032
+ ends_at?: string | undefined
24033
+ errors: Array<{
24034
+ error_code: string
24035
+ message: string
24036
+ }>
24037
+ warnings: Array<{
24038
+ warning_code: string
24039
+ message: string
24040
+ }>
24041
+ is_multi_phone_sync_credential?: boolean | undefined
24042
+ is_latest_desired_state_synced_with_provider?:
24043
+ | boolean
24044
+ | undefined
24045
+ latest_desired_state_synced_with_provider_at?:
24046
+ | string
24047
+ | undefined
24048
+ visionline_metadata?:
24049
+ | {
24050
+ card_function_type: 'guest' | 'staff'
24051
+ joiner_acs_credential_ids?: string[] | undefined
24052
+ guest_acs_entrance_ids?: string[] | undefined
24053
+ common_acs_entrance_ids?: string[] | undefined
24054
+ is_valid?: boolean | undefined
24055
+ auto_join?: boolean | undefined
24056
+ card_id?: string | undefined
24057
+ credential_id?: string | undefined
24058
+ }
24059
+ | undefined
24060
+ is_managed: true
24061
+ }
24062
+ | {
24063
+ acs_credential_id: string
24064
+ acs_user_id?: string | undefined
24065
+ acs_credential_pool_id?: string | undefined
24066
+ acs_system_id: string
24067
+ parent_acs_credential_id?: string | undefined
24068
+ display_name: string
24069
+ code?: (string | undefined) | null
24070
+ card_number?: (string | undefined) | null
24071
+ is_issued?: boolean | undefined
24072
+ issued_at?: (string | undefined) | null
24073
+ access_method: 'code' | 'card' | 'mobile_key'
24074
+ external_type?:
24075
+ | (
24076
+ | 'pti_card'
24077
+ | 'brivo_credential'
24078
+ | 'hid_credential'
24079
+ | 'visionline_card'
24080
+ | 'salto_ks_credential'
24081
+ )
24082
+ | undefined
24083
+ external_type_display_name?: string | undefined
24084
+ created_at: string
24085
+ workspace_id: string
24086
+ starts_at?: string | undefined
24087
+ ends_at?: string | undefined
24088
+ errors: Array<{
24089
+ error_code: string
24090
+ message: string
24091
+ }>
24092
+ warnings: Array<{
24093
+ warning_code: string
24094
+ message: string
24095
+ }>
24096
+ is_multi_phone_sync_credential?: boolean | undefined
24097
+ is_latest_desired_state_synced_with_provider?:
24098
+ | boolean
24099
+ | undefined
24100
+ latest_desired_state_synced_with_provider_at?:
24101
+ | string
24102
+ | undefined
24103
+ visionline_metadata?:
24104
+ | {
24105
+ card_function_type: 'guest' | 'staff'
24106
+ joiner_acs_credential_ids?: string[] | undefined
24107
+ guest_acs_entrance_ids?: string[] | undefined
24108
+ common_acs_entrance_ids?: string[] | undefined
24109
+ is_valid?: boolean | undefined
24110
+ auto_join?: boolean | undefined
24111
+ card_id?: string | undefined
24112
+ credential_id?: string | undefined
24113
+ }
24114
+ | undefined
24115
+ is_managed: false
24116
+ }
24117
+ )
24118
+ | null
24119
+ }
24120
+ }
24121
+ | {
24122
+ /** The ID of the action attempt. */
24123
+ action_attempt_id: string
24124
+ status: 'error'
24125
+ result: null
24126
+ action_type: 'SCAN_CARD'
20994
24127
  error: {
20995
24128
  type: 'no_card_on_encoder'
20996
24129
  message: string
@@ -21601,25 +24734,165 @@ export interface Routes {
21601
24734
  status: 'pending'
21602
24735
  result: null
21603
24736
  error: null
21604
- action_type: 'READ_CARD'
24737
+ action_type: 'SCAN_CARD'
21605
24738
  }
21606
24739
  | {
21607
24740
  /** The ID of the action attempt. */
21608
24741
  action_attempt_id: string
21609
24742
  status: 'success'
21610
24743
  error: null
21611
- action_type: 'READ_CARD'
24744
+ action_type: 'SCAN_CARD'
21612
24745
  result: {
21613
- /** A number or string that physically identifies this card. */
21614
- card_number: string | null
21615
- }
21616
- }
21617
- | {
21618
- /** The ID of the action attempt. */
21619
- action_attempt_id: string
21620
- status: 'error'
21621
- result: null
21622
- action_type: 'READ_CARD'
24746
+ /** Snapshot of the card data read from the physical encoder. */
24747
+ acs_credential_on_encoder: {
24748
+ /** Date and time the credential was created. */
24749
+ created_at: string
24750
+ is_issued: boolean | null
24751
+ /** Date and time the credential will become useable. */
24752
+ starts_at: string | null
24753
+ /** Date and time the credential will stop being useable. */
24754
+ ends_at: string | null
24755
+ /** A number or string that physically identifies this card. */
24756
+ card_number: string | null
24757
+ visionline_metadata?:
24758
+ | {
24759
+ card_id: string
24760
+ card_function_type: 'guest' | 'staff'
24761
+ cancelled: boolean
24762
+ discarded: boolean
24763
+ expired: boolean
24764
+ overwritten: boolean
24765
+ overridden?: boolean | undefined
24766
+ pending_auto_update: boolean
24767
+ card_format: 'TLCode' | 'rfid48'
24768
+ card_holder?: string | undefined
24769
+ number_of_issued_cards: number
24770
+ }
24771
+ | undefined
24772
+ }
24773
+ /** Matching acs_credential currently encoded on this card. */
24774
+ acs_credential_on_seam:
24775
+ | (
24776
+ | {
24777
+ acs_credential_id: string
24778
+ acs_user_id?: string | undefined
24779
+ acs_credential_pool_id?: string | undefined
24780
+ acs_system_id: string
24781
+ parent_acs_credential_id?: string | undefined
24782
+ display_name: string
24783
+ code?: (string | undefined) | null
24784
+ card_number?: (string | undefined) | null
24785
+ is_issued?: boolean | undefined
24786
+ issued_at?: (string | undefined) | null
24787
+ access_method: 'code' | 'card' | 'mobile_key'
24788
+ external_type?:
24789
+ | (
24790
+ | 'pti_card'
24791
+ | 'brivo_credential'
24792
+ | 'hid_credential'
24793
+ | 'visionline_card'
24794
+ | 'salto_ks_credential'
24795
+ )
24796
+ | undefined
24797
+ external_type_display_name?: string | undefined
24798
+ created_at: string
24799
+ workspace_id: string
24800
+ starts_at?: string | undefined
24801
+ ends_at?: string | undefined
24802
+ errors: Array<{
24803
+ error_code: string
24804
+ message: string
24805
+ }>
24806
+ warnings: Array<{
24807
+ warning_code: string
24808
+ message: string
24809
+ }>
24810
+ is_multi_phone_sync_credential?: boolean | undefined
24811
+ is_latest_desired_state_synced_with_provider?:
24812
+ | boolean
24813
+ | undefined
24814
+ latest_desired_state_synced_with_provider_at?:
24815
+ | string
24816
+ | undefined
24817
+ visionline_metadata?:
24818
+ | {
24819
+ card_function_type: 'guest' | 'staff'
24820
+ joiner_acs_credential_ids?: string[] | undefined
24821
+ guest_acs_entrance_ids?: string[] | undefined
24822
+ common_acs_entrance_ids?: string[] | undefined
24823
+ is_valid?: boolean | undefined
24824
+ auto_join?: boolean | undefined
24825
+ card_id?: string | undefined
24826
+ credential_id?: string | undefined
24827
+ }
24828
+ | undefined
24829
+ is_managed: true
24830
+ }
24831
+ | {
24832
+ acs_credential_id: string
24833
+ acs_user_id?: string | undefined
24834
+ acs_credential_pool_id?: string | undefined
24835
+ acs_system_id: string
24836
+ parent_acs_credential_id?: string | undefined
24837
+ display_name: string
24838
+ code?: (string | undefined) | null
24839
+ card_number?: (string | undefined) | null
24840
+ is_issued?: boolean | undefined
24841
+ issued_at?: (string | undefined) | null
24842
+ access_method: 'code' | 'card' | 'mobile_key'
24843
+ external_type?:
24844
+ | (
24845
+ | 'pti_card'
24846
+ | 'brivo_credential'
24847
+ | 'hid_credential'
24848
+ | 'visionline_card'
24849
+ | 'salto_ks_credential'
24850
+ )
24851
+ | undefined
24852
+ external_type_display_name?: string | undefined
24853
+ created_at: string
24854
+ workspace_id: string
24855
+ starts_at?: string | undefined
24856
+ ends_at?: string | undefined
24857
+ errors: Array<{
24858
+ error_code: string
24859
+ message: string
24860
+ }>
24861
+ warnings: Array<{
24862
+ warning_code: string
24863
+ message: string
24864
+ }>
24865
+ is_multi_phone_sync_credential?: boolean | undefined
24866
+ is_latest_desired_state_synced_with_provider?:
24867
+ | boolean
24868
+ | undefined
24869
+ latest_desired_state_synced_with_provider_at?:
24870
+ | string
24871
+ | undefined
24872
+ visionline_metadata?:
24873
+ | {
24874
+ card_function_type: 'guest' | 'staff'
24875
+ joiner_acs_credential_ids?: string[] | undefined
24876
+ guest_acs_entrance_ids?: string[] | undefined
24877
+ common_acs_entrance_ids?: string[] | undefined
24878
+ is_valid?: boolean | undefined
24879
+ auto_join?: boolean | undefined
24880
+ card_id?: string | undefined
24881
+ credential_id?: string | undefined
24882
+ }
24883
+ | undefined
24884
+ is_managed: false
24885
+ }
24886
+ )
24887
+ | null
24888
+ }
24889
+ }
24890
+ | {
24891
+ /** The ID of the action attempt. */
24892
+ action_attempt_id: string
24893
+ status: 'error'
24894
+ result: null
24895
+ action_type: 'SCAN_CARD'
21623
24896
  error: {
21624
24897
  type: 'no_card_on_encoder'
21625
24898
  message: string
@@ -23977,25 +27250,165 @@ export interface Routes {
23977
27250
  status: 'pending'
23978
27251
  result: null
23979
27252
  error: null
23980
- action_type: 'READ_CARD'
27253
+ action_type: 'SCAN_CARD'
23981
27254
  }
23982
27255
  | {
23983
27256
  /** The ID of the action attempt. */
23984
27257
  action_attempt_id: string
23985
27258
  status: 'success'
23986
27259
  error: null
23987
- action_type: 'READ_CARD'
27260
+ action_type: 'SCAN_CARD'
23988
27261
  result: {
23989
- /** A number or string that physically identifies this card. */
23990
- card_number: string | null
23991
- }
23992
- }
23993
- | {
23994
- /** The ID of the action attempt. */
23995
- action_attempt_id: string
23996
- status: 'error'
23997
- result: null
23998
- action_type: 'READ_CARD'
27262
+ /** Snapshot of the card data read from the physical encoder. */
27263
+ acs_credential_on_encoder: {
27264
+ /** Date and time the credential was created. */
27265
+ created_at: string
27266
+ is_issued: boolean | null
27267
+ /** Date and time the credential will become useable. */
27268
+ starts_at: string | null
27269
+ /** Date and time the credential will stop being useable. */
27270
+ ends_at: string | null
27271
+ /** A number or string that physically identifies this card. */
27272
+ card_number: string | null
27273
+ visionline_metadata?:
27274
+ | {
27275
+ card_id: string
27276
+ card_function_type: 'guest' | 'staff'
27277
+ cancelled: boolean
27278
+ discarded: boolean
27279
+ expired: boolean
27280
+ overwritten: boolean
27281
+ overridden?: boolean | undefined
27282
+ pending_auto_update: boolean
27283
+ card_format: 'TLCode' | 'rfid48'
27284
+ card_holder?: string | undefined
27285
+ number_of_issued_cards: number
27286
+ }
27287
+ | undefined
27288
+ }
27289
+ /** Matching acs_credential currently encoded on this card. */
27290
+ acs_credential_on_seam:
27291
+ | (
27292
+ | {
27293
+ acs_credential_id: string
27294
+ acs_user_id?: string | undefined
27295
+ acs_credential_pool_id?: string | undefined
27296
+ acs_system_id: string
27297
+ parent_acs_credential_id?: string | undefined
27298
+ display_name: string
27299
+ code?: (string | undefined) | null
27300
+ card_number?: (string | undefined) | null
27301
+ is_issued?: boolean | undefined
27302
+ issued_at?: (string | undefined) | null
27303
+ access_method: 'code' | 'card' | 'mobile_key'
27304
+ external_type?:
27305
+ | (
27306
+ | 'pti_card'
27307
+ | 'brivo_credential'
27308
+ | 'hid_credential'
27309
+ | 'visionline_card'
27310
+ | 'salto_ks_credential'
27311
+ )
27312
+ | undefined
27313
+ external_type_display_name?: string | undefined
27314
+ created_at: string
27315
+ workspace_id: string
27316
+ starts_at?: string | undefined
27317
+ ends_at?: string | undefined
27318
+ errors: Array<{
27319
+ error_code: string
27320
+ message: string
27321
+ }>
27322
+ warnings: Array<{
27323
+ warning_code: string
27324
+ message: string
27325
+ }>
27326
+ is_multi_phone_sync_credential?: boolean | undefined
27327
+ is_latest_desired_state_synced_with_provider?:
27328
+ | boolean
27329
+ | undefined
27330
+ latest_desired_state_synced_with_provider_at?:
27331
+ | string
27332
+ | undefined
27333
+ visionline_metadata?:
27334
+ | {
27335
+ card_function_type: 'guest' | 'staff'
27336
+ joiner_acs_credential_ids?: string[] | undefined
27337
+ guest_acs_entrance_ids?: string[] | undefined
27338
+ common_acs_entrance_ids?: string[] | undefined
27339
+ is_valid?: boolean | undefined
27340
+ auto_join?: boolean | undefined
27341
+ card_id?: string | undefined
27342
+ credential_id?: string | undefined
27343
+ }
27344
+ | undefined
27345
+ is_managed: true
27346
+ }
27347
+ | {
27348
+ acs_credential_id: string
27349
+ acs_user_id?: string | undefined
27350
+ acs_credential_pool_id?: string | undefined
27351
+ acs_system_id: string
27352
+ parent_acs_credential_id?: string | undefined
27353
+ display_name: string
27354
+ code?: (string | undefined) | null
27355
+ card_number?: (string | undefined) | null
27356
+ is_issued?: boolean | undefined
27357
+ issued_at?: (string | undefined) | null
27358
+ access_method: 'code' | 'card' | 'mobile_key'
27359
+ external_type?:
27360
+ | (
27361
+ | 'pti_card'
27362
+ | 'brivo_credential'
27363
+ | 'hid_credential'
27364
+ | 'visionline_card'
27365
+ | 'salto_ks_credential'
27366
+ )
27367
+ | undefined
27368
+ external_type_display_name?: string | undefined
27369
+ created_at: string
27370
+ workspace_id: string
27371
+ starts_at?: string | undefined
27372
+ ends_at?: string | undefined
27373
+ errors: Array<{
27374
+ error_code: string
27375
+ message: string
27376
+ }>
27377
+ warnings: Array<{
27378
+ warning_code: string
27379
+ message: string
27380
+ }>
27381
+ is_multi_phone_sync_credential?: boolean | undefined
27382
+ is_latest_desired_state_synced_with_provider?:
27383
+ | boolean
27384
+ | undefined
27385
+ latest_desired_state_synced_with_provider_at?:
27386
+ | string
27387
+ | undefined
27388
+ visionline_metadata?:
27389
+ | {
27390
+ card_function_type: 'guest' | 'staff'
27391
+ joiner_acs_credential_ids?: string[] | undefined
27392
+ guest_acs_entrance_ids?: string[] | undefined
27393
+ common_acs_entrance_ids?: string[] | undefined
27394
+ is_valid?: boolean | undefined
27395
+ auto_join?: boolean | undefined
27396
+ card_id?: string | undefined
27397
+ credential_id?: string | undefined
27398
+ }
27399
+ | undefined
27400
+ is_managed: false
27401
+ }
27402
+ )
27403
+ | null
27404
+ }
27405
+ }
27406
+ | {
27407
+ /** The ID of the action attempt. */
27408
+ action_attempt_id: string
27409
+ status: 'error'
27410
+ result: null
27411
+ action_type: 'SCAN_CARD'
23999
27412
  error: {
24000
27413
  type: 'no_card_on_encoder'
24001
27414
  message: string