@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.
- package/dist/connect.cjs +373 -48
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +3686 -120
- package/lib/seam/connect/models/acs/acs-credential.d.ts +83 -0
- package/lib/seam/connect/models/acs/acs-credential.js +38 -0
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +798 -14
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -2
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/scan-card.d.ts +875 -0
- package/lib/seam/connect/models/action-attempts/{read-card.js → scan-card.js} +8 -12
- package/lib/seam/connect/models/action-attempts/scan-card.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +247 -4
- package/lib/seam/connect/openapi.js +320 -16
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2715 -176
- package/package.json +2 -2
- package/src/lib/seam/connect/models/acs/acs-credential.ts +48 -0
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -2
- package/src/lib/seam/connect/models/action-attempts/{read-card.ts → scan-card.ts} +15 -12
- package/src/lib/seam/connect/openapi.ts +325 -16
- package/src/lib/seam/connect/route-types.ts +3673 -260
- package/lib/seam/connect/models/action-attempts/read-card.d.ts +0 -91
- package/lib/seam/connect/models/action-attempts/read-card.js.map +0 -1
|
@@ -79,23 +79,128 @@ export interface Routes {
|
|
|
79
79
|
status: 'pending';
|
|
80
80
|
result: null;
|
|
81
81
|
error: null;
|
|
82
|
-
action_type: '
|
|
82
|
+
action_type: 'SCAN_CARD';
|
|
83
83
|
} | {
|
|
84
84
|
/** The ID of the action attempt. */
|
|
85
85
|
action_attempt_id: string;
|
|
86
86
|
status: 'success';
|
|
87
87
|
error: null;
|
|
88
|
-
action_type: '
|
|
88
|
+
action_type: 'SCAN_CARD';
|
|
89
89
|
result: {
|
|
90
|
-
/**
|
|
91
|
-
|
|
90
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
91
|
+
acs_credential_on_encoder: {
|
|
92
|
+
/** Date and time the credential was created. */
|
|
93
|
+
created_at: string;
|
|
94
|
+
is_issued: boolean | null;
|
|
95
|
+
/** Date and time the credential will become useable. */
|
|
96
|
+
starts_at: string | null;
|
|
97
|
+
/** Date and time the credential will stop being useable. */
|
|
98
|
+
ends_at: string | null;
|
|
99
|
+
/** A number or string that physically identifies this card. */
|
|
100
|
+
card_number: string | null;
|
|
101
|
+
visionline_metadata?: {
|
|
102
|
+
card_id: string;
|
|
103
|
+
card_function_type: 'guest' | 'staff';
|
|
104
|
+
cancelled: boolean;
|
|
105
|
+
discarded: boolean;
|
|
106
|
+
expired: boolean;
|
|
107
|
+
overwritten: boolean;
|
|
108
|
+
overridden?: boolean | undefined;
|
|
109
|
+
pending_auto_update: boolean;
|
|
110
|
+
card_format: 'TLCode' | 'rfid48';
|
|
111
|
+
card_holder?: string | undefined;
|
|
112
|
+
number_of_issued_cards: number;
|
|
113
|
+
} | undefined;
|
|
114
|
+
};
|
|
115
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
116
|
+
acs_credential_on_seam: ({
|
|
117
|
+
acs_credential_id: string;
|
|
118
|
+
acs_user_id?: string | undefined;
|
|
119
|
+
acs_credential_pool_id?: string | undefined;
|
|
120
|
+
acs_system_id: string;
|
|
121
|
+
parent_acs_credential_id?: string | undefined;
|
|
122
|
+
display_name: string;
|
|
123
|
+
code?: (string | undefined) | null;
|
|
124
|
+
card_number?: (string | undefined) | null;
|
|
125
|
+
is_issued?: boolean | undefined;
|
|
126
|
+
issued_at?: (string | undefined) | null;
|
|
127
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
128
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
129
|
+
external_type_display_name?: string | undefined;
|
|
130
|
+
created_at: string;
|
|
131
|
+
workspace_id: string;
|
|
132
|
+
starts_at?: string | undefined;
|
|
133
|
+
ends_at?: string | undefined;
|
|
134
|
+
errors: Array<{
|
|
135
|
+
error_code: string;
|
|
136
|
+
message: string;
|
|
137
|
+
}>;
|
|
138
|
+
warnings: Array<{
|
|
139
|
+
warning_code: string;
|
|
140
|
+
message: string;
|
|
141
|
+
}>;
|
|
142
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
143
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
144
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
145
|
+
visionline_metadata?: {
|
|
146
|
+
card_function_type: 'guest' | 'staff';
|
|
147
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
148
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
149
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
150
|
+
is_valid?: boolean | undefined;
|
|
151
|
+
auto_join?: boolean | undefined;
|
|
152
|
+
card_id?: string | undefined;
|
|
153
|
+
credential_id?: string | undefined;
|
|
154
|
+
} | undefined;
|
|
155
|
+
is_managed: true;
|
|
156
|
+
} | {
|
|
157
|
+
acs_credential_id: string;
|
|
158
|
+
acs_user_id?: string | undefined;
|
|
159
|
+
acs_credential_pool_id?: string | undefined;
|
|
160
|
+
acs_system_id: string;
|
|
161
|
+
parent_acs_credential_id?: string | undefined;
|
|
162
|
+
display_name: string;
|
|
163
|
+
code?: (string | undefined) | null;
|
|
164
|
+
card_number?: (string | undefined) | null;
|
|
165
|
+
is_issued?: boolean | undefined;
|
|
166
|
+
issued_at?: (string | undefined) | null;
|
|
167
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
168
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
169
|
+
external_type_display_name?: string | undefined;
|
|
170
|
+
created_at: string;
|
|
171
|
+
workspace_id: string;
|
|
172
|
+
starts_at?: string | undefined;
|
|
173
|
+
ends_at?: string | undefined;
|
|
174
|
+
errors: Array<{
|
|
175
|
+
error_code: string;
|
|
176
|
+
message: string;
|
|
177
|
+
}>;
|
|
178
|
+
warnings: Array<{
|
|
179
|
+
warning_code: string;
|
|
180
|
+
message: string;
|
|
181
|
+
}>;
|
|
182
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
183
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
184
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
185
|
+
visionline_metadata?: {
|
|
186
|
+
card_function_type: 'guest' | 'staff';
|
|
187
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
188
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
189
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
190
|
+
is_valid?: boolean | undefined;
|
|
191
|
+
auto_join?: boolean | undefined;
|
|
192
|
+
card_id?: string | undefined;
|
|
193
|
+
credential_id?: string | undefined;
|
|
194
|
+
} | undefined;
|
|
195
|
+
is_managed: false;
|
|
196
|
+
}) | null;
|
|
92
197
|
};
|
|
93
198
|
} | {
|
|
94
199
|
/** The ID of the action attempt. */
|
|
95
200
|
action_attempt_id: string;
|
|
96
201
|
status: 'error';
|
|
97
202
|
result: null;
|
|
98
|
-
action_type: '
|
|
203
|
+
action_type: 'SCAN_CARD';
|
|
99
204
|
error: {
|
|
100
205
|
type: 'no_card_on_encoder';
|
|
101
206
|
message: string;
|
|
@@ -683,23 +788,128 @@ export interface Routes {
|
|
|
683
788
|
status: 'pending';
|
|
684
789
|
result: null;
|
|
685
790
|
error: null;
|
|
686
|
-
action_type: '
|
|
791
|
+
action_type: 'SCAN_CARD';
|
|
687
792
|
} | {
|
|
688
793
|
/** The ID of the action attempt. */
|
|
689
794
|
action_attempt_id: string;
|
|
690
795
|
status: 'success';
|
|
691
796
|
error: null;
|
|
692
|
-
action_type: '
|
|
797
|
+
action_type: 'SCAN_CARD';
|
|
693
798
|
result: {
|
|
694
|
-
/**
|
|
695
|
-
|
|
799
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
800
|
+
acs_credential_on_encoder: {
|
|
801
|
+
/** Date and time the credential was created. */
|
|
802
|
+
created_at: string;
|
|
803
|
+
is_issued: boolean | null;
|
|
804
|
+
/** Date and time the credential will become useable. */
|
|
805
|
+
starts_at: string | null;
|
|
806
|
+
/** Date and time the credential will stop being useable. */
|
|
807
|
+
ends_at: string | null;
|
|
808
|
+
/** A number or string that physically identifies this card. */
|
|
809
|
+
card_number: string | null;
|
|
810
|
+
visionline_metadata?: {
|
|
811
|
+
card_id: string;
|
|
812
|
+
card_function_type: 'guest' | 'staff';
|
|
813
|
+
cancelled: boolean;
|
|
814
|
+
discarded: boolean;
|
|
815
|
+
expired: boolean;
|
|
816
|
+
overwritten: boolean;
|
|
817
|
+
overridden?: boolean | undefined;
|
|
818
|
+
pending_auto_update: boolean;
|
|
819
|
+
card_format: 'TLCode' | 'rfid48';
|
|
820
|
+
card_holder?: string | undefined;
|
|
821
|
+
number_of_issued_cards: number;
|
|
822
|
+
} | undefined;
|
|
823
|
+
};
|
|
824
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
825
|
+
acs_credential_on_seam: ({
|
|
826
|
+
acs_credential_id: string;
|
|
827
|
+
acs_user_id?: string | undefined;
|
|
828
|
+
acs_credential_pool_id?: string | undefined;
|
|
829
|
+
acs_system_id: string;
|
|
830
|
+
parent_acs_credential_id?: string | undefined;
|
|
831
|
+
display_name: string;
|
|
832
|
+
code?: (string | undefined) | null;
|
|
833
|
+
card_number?: (string | undefined) | null;
|
|
834
|
+
is_issued?: boolean | undefined;
|
|
835
|
+
issued_at?: (string | undefined) | null;
|
|
836
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
837
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
838
|
+
external_type_display_name?: string | undefined;
|
|
839
|
+
created_at: string;
|
|
840
|
+
workspace_id: string;
|
|
841
|
+
starts_at?: string | undefined;
|
|
842
|
+
ends_at?: string | undefined;
|
|
843
|
+
errors: Array<{
|
|
844
|
+
error_code: string;
|
|
845
|
+
message: string;
|
|
846
|
+
}>;
|
|
847
|
+
warnings: Array<{
|
|
848
|
+
warning_code: string;
|
|
849
|
+
message: string;
|
|
850
|
+
}>;
|
|
851
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
852
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
853
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
854
|
+
visionline_metadata?: {
|
|
855
|
+
card_function_type: 'guest' | 'staff';
|
|
856
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
857
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
858
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
859
|
+
is_valid?: boolean | undefined;
|
|
860
|
+
auto_join?: boolean | undefined;
|
|
861
|
+
card_id?: string | undefined;
|
|
862
|
+
credential_id?: string | undefined;
|
|
863
|
+
} | undefined;
|
|
864
|
+
is_managed: true;
|
|
865
|
+
} | {
|
|
866
|
+
acs_credential_id: string;
|
|
867
|
+
acs_user_id?: string | undefined;
|
|
868
|
+
acs_credential_pool_id?: string | undefined;
|
|
869
|
+
acs_system_id: string;
|
|
870
|
+
parent_acs_credential_id?: string | undefined;
|
|
871
|
+
display_name: string;
|
|
872
|
+
code?: (string | undefined) | null;
|
|
873
|
+
card_number?: (string | undefined) | null;
|
|
874
|
+
is_issued?: boolean | undefined;
|
|
875
|
+
issued_at?: (string | undefined) | null;
|
|
876
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
877
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
878
|
+
external_type_display_name?: string | undefined;
|
|
879
|
+
created_at: string;
|
|
880
|
+
workspace_id: string;
|
|
881
|
+
starts_at?: string | undefined;
|
|
882
|
+
ends_at?: string | undefined;
|
|
883
|
+
errors: Array<{
|
|
884
|
+
error_code: string;
|
|
885
|
+
message: string;
|
|
886
|
+
}>;
|
|
887
|
+
warnings: Array<{
|
|
888
|
+
warning_code: string;
|
|
889
|
+
message: string;
|
|
890
|
+
}>;
|
|
891
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
892
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
893
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
894
|
+
visionline_metadata?: {
|
|
895
|
+
card_function_type: 'guest' | 'staff';
|
|
896
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
897
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
898
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
899
|
+
is_valid?: boolean | undefined;
|
|
900
|
+
auto_join?: boolean | undefined;
|
|
901
|
+
card_id?: string | undefined;
|
|
902
|
+
credential_id?: string | undefined;
|
|
903
|
+
} | undefined;
|
|
904
|
+
is_managed: false;
|
|
905
|
+
}) | null;
|
|
696
906
|
};
|
|
697
907
|
} | {
|
|
698
908
|
/** The ID of the action attempt. */
|
|
699
909
|
action_attempt_id: string;
|
|
700
910
|
status: 'error';
|
|
701
911
|
result: null;
|
|
702
|
-
action_type: '
|
|
912
|
+
action_type: 'SCAN_CARD';
|
|
703
913
|
error: {
|
|
704
914
|
type: 'no_card_on_encoder';
|
|
705
915
|
message: string;
|
|
@@ -1444,23 +1654,128 @@ export interface Routes {
|
|
|
1444
1654
|
status: 'pending';
|
|
1445
1655
|
result: null;
|
|
1446
1656
|
error: null;
|
|
1447
|
-
action_type: '
|
|
1657
|
+
action_type: 'SCAN_CARD';
|
|
1448
1658
|
} | {
|
|
1449
1659
|
/** The ID of the action attempt. */
|
|
1450
1660
|
action_attempt_id: string;
|
|
1451
1661
|
status: 'success';
|
|
1452
1662
|
error: null;
|
|
1453
|
-
action_type: '
|
|
1663
|
+
action_type: 'SCAN_CARD';
|
|
1454
1664
|
result: {
|
|
1455
|
-
/**
|
|
1456
|
-
|
|
1665
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
1666
|
+
acs_credential_on_encoder: {
|
|
1667
|
+
/** Date and time the credential was created. */
|
|
1668
|
+
created_at: string;
|
|
1669
|
+
is_issued: boolean | null;
|
|
1670
|
+
/** Date and time the credential will become useable. */
|
|
1671
|
+
starts_at: string | null;
|
|
1672
|
+
/** Date and time the credential will stop being useable. */
|
|
1673
|
+
ends_at: string | null;
|
|
1674
|
+
/** A number or string that physically identifies this card. */
|
|
1675
|
+
card_number: string | null;
|
|
1676
|
+
visionline_metadata?: {
|
|
1677
|
+
card_id: string;
|
|
1678
|
+
card_function_type: 'guest' | 'staff';
|
|
1679
|
+
cancelled: boolean;
|
|
1680
|
+
discarded: boolean;
|
|
1681
|
+
expired: boolean;
|
|
1682
|
+
overwritten: boolean;
|
|
1683
|
+
overridden?: boolean | undefined;
|
|
1684
|
+
pending_auto_update: boolean;
|
|
1685
|
+
card_format: 'TLCode' | 'rfid48';
|
|
1686
|
+
card_holder?: string | undefined;
|
|
1687
|
+
number_of_issued_cards: number;
|
|
1688
|
+
} | undefined;
|
|
1689
|
+
};
|
|
1690
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
1691
|
+
acs_credential_on_seam: ({
|
|
1692
|
+
acs_credential_id: string;
|
|
1693
|
+
acs_user_id?: string | undefined;
|
|
1694
|
+
acs_credential_pool_id?: string | undefined;
|
|
1695
|
+
acs_system_id: string;
|
|
1696
|
+
parent_acs_credential_id?: string | undefined;
|
|
1697
|
+
display_name: string;
|
|
1698
|
+
code?: (string | undefined) | null;
|
|
1699
|
+
card_number?: (string | undefined) | null;
|
|
1700
|
+
is_issued?: boolean | undefined;
|
|
1701
|
+
issued_at?: (string | undefined) | null;
|
|
1702
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
1703
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
1704
|
+
external_type_display_name?: string | undefined;
|
|
1705
|
+
created_at: string;
|
|
1706
|
+
workspace_id: string;
|
|
1707
|
+
starts_at?: string | undefined;
|
|
1708
|
+
ends_at?: string | undefined;
|
|
1709
|
+
errors: Array<{
|
|
1710
|
+
error_code: string;
|
|
1711
|
+
message: string;
|
|
1712
|
+
}>;
|
|
1713
|
+
warnings: Array<{
|
|
1714
|
+
warning_code: string;
|
|
1715
|
+
message: string;
|
|
1716
|
+
}>;
|
|
1717
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
1718
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
1719
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
1720
|
+
visionline_metadata?: {
|
|
1721
|
+
card_function_type: 'guest' | 'staff';
|
|
1722
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
1723
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
1724
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
1725
|
+
is_valid?: boolean | undefined;
|
|
1726
|
+
auto_join?: boolean | undefined;
|
|
1727
|
+
card_id?: string | undefined;
|
|
1728
|
+
credential_id?: string | undefined;
|
|
1729
|
+
} | undefined;
|
|
1730
|
+
is_managed: true;
|
|
1731
|
+
} | {
|
|
1732
|
+
acs_credential_id: string;
|
|
1733
|
+
acs_user_id?: string | undefined;
|
|
1734
|
+
acs_credential_pool_id?: string | undefined;
|
|
1735
|
+
acs_system_id: string;
|
|
1736
|
+
parent_acs_credential_id?: string | undefined;
|
|
1737
|
+
display_name: string;
|
|
1738
|
+
code?: (string | undefined) | null;
|
|
1739
|
+
card_number?: (string | undefined) | null;
|
|
1740
|
+
is_issued?: boolean | undefined;
|
|
1741
|
+
issued_at?: (string | undefined) | null;
|
|
1742
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
1743
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
1744
|
+
external_type_display_name?: string | undefined;
|
|
1745
|
+
created_at: string;
|
|
1746
|
+
workspace_id: string;
|
|
1747
|
+
starts_at?: string | undefined;
|
|
1748
|
+
ends_at?: string | undefined;
|
|
1749
|
+
errors: Array<{
|
|
1750
|
+
error_code: string;
|
|
1751
|
+
message: string;
|
|
1752
|
+
}>;
|
|
1753
|
+
warnings: Array<{
|
|
1754
|
+
warning_code: string;
|
|
1755
|
+
message: string;
|
|
1756
|
+
}>;
|
|
1757
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
1758
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
1759
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
1760
|
+
visionline_metadata?: {
|
|
1761
|
+
card_function_type: 'guest' | 'staff';
|
|
1762
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
1763
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
1764
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
1765
|
+
is_valid?: boolean | undefined;
|
|
1766
|
+
auto_join?: boolean | undefined;
|
|
1767
|
+
card_id?: string | undefined;
|
|
1768
|
+
credential_id?: string | undefined;
|
|
1769
|
+
} | undefined;
|
|
1770
|
+
is_managed: false;
|
|
1771
|
+
}) | null;
|
|
1457
1772
|
};
|
|
1458
1773
|
} | {
|
|
1459
1774
|
/** The ID of the action attempt. */
|
|
1460
1775
|
action_attempt_id: string;
|
|
1461
1776
|
status: 'error';
|
|
1462
1777
|
result: null;
|
|
1463
|
-
action_type: '
|
|
1778
|
+
action_type: 'SCAN_CARD';
|
|
1464
1779
|
error: {
|
|
1465
1780
|
type: 'no_card_on_encoder';
|
|
1466
1781
|
message: string;
|
|
@@ -2035,23 +2350,128 @@ export interface Routes {
|
|
|
2035
2350
|
status: 'pending';
|
|
2036
2351
|
result: null;
|
|
2037
2352
|
error: null;
|
|
2038
|
-
action_type: '
|
|
2353
|
+
action_type: 'SCAN_CARD';
|
|
2039
2354
|
} | {
|
|
2040
2355
|
/** The ID of the action attempt. */
|
|
2041
2356
|
action_attempt_id: string;
|
|
2042
2357
|
status: 'success';
|
|
2043
2358
|
error: null;
|
|
2044
|
-
action_type: '
|
|
2359
|
+
action_type: 'SCAN_CARD';
|
|
2045
2360
|
result: {
|
|
2046
|
-
/**
|
|
2047
|
-
|
|
2361
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
2362
|
+
acs_credential_on_encoder: {
|
|
2363
|
+
/** Date and time the credential was created. */
|
|
2364
|
+
created_at: string;
|
|
2365
|
+
is_issued: boolean | null;
|
|
2366
|
+
/** Date and time the credential will become useable. */
|
|
2367
|
+
starts_at: string | null;
|
|
2368
|
+
/** Date and time the credential will stop being useable. */
|
|
2369
|
+
ends_at: string | null;
|
|
2370
|
+
/** A number or string that physically identifies this card. */
|
|
2371
|
+
card_number: string | null;
|
|
2372
|
+
visionline_metadata?: {
|
|
2373
|
+
card_id: string;
|
|
2374
|
+
card_function_type: 'guest' | 'staff';
|
|
2375
|
+
cancelled: boolean;
|
|
2376
|
+
discarded: boolean;
|
|
2377
|
+
expired: boolean;
|
|
2378
|
+
overwritten: boolean;
|
|
2379
|
+
overridden?: boolean | undefined;
|
|
2380
|
+
pending_auto_update: boolean;
|
|
2381
|
+
card_format: 'TLCode' | 'rfid48';
|
|
2382
|
+
card_holder?: string | undefined;
|
|
2383
|
+
number_of_issued_cards: number;
|
|
2384
|
+
} | undefined;
|
|
2385
|
+
};
|
|
2386
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
2387
|
+
acs_credential_on_seam: ({
|
|
2388
|
+
acs_credential_id: string;
|
|
2389
|
+
acs_user_id?: string | undefined;
|
|
2390
|
+
acs_credential_pool_id?: string | undefined;
|
|
2391
|
+
acs_system_id: string;
|
|
2392
|
+
parent_acs_credential_id?: string | undefined;
|
|
2393
|
+
display_name: string;
|
|
2394
|
+
code?: (string | undefined) | null;
|
|
2395
|
+
card_number?: (string | undefined) | null;
|
|
2396
|
+
is_issued?: boolean | undefined;
|
|
2397
|
+
issued_at?: (string | undefined) | null;
|
|
2398
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
2399
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
2400
|
+
external_type_display_name?: string | undefined;
|
|
2401
|
+
created_at: string;
|
|
2402
|
+
workspace_id: string;
|
|
2403
|
+
starts_at?: string | undefined;
|
|
2404
|
+
ends_at?: string | undefined;
|
|
2405
|
+
errors: Array<{
|
|
2406
|
+
error_code: string;
|
|
2407
|
+
message: string;
|
|
2408
|
+
}>;
|
|
2409
|
+
warnings: Array<{
|
|
2410
|
+
warning_code: string;
|
|
2411
|
+
message: string;
|
|
2412
|
+
}>;
|
|
2413
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
2414
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
2415
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
2416
|
+
visionline_metadata?: {
|
|
2417
|
+
card_function_type: 'guest' | 'staff';
|
|
2418
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
2419
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
2420
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
2421
|
+
is_valid?: boolean | undefined;
|
|
2422
|
+
auto_join?: boolean | undefined;
|
|
2423
|
+
card_id?: string | undefined;
|
|
2424
|
+
credential_id?: string | undefined;
|
|
2425
|
+
} | undefined;
|
|
2426
|
+
is_managed: true;
|
|
2427
|
+
} | {
|
|
2428
|
+
acs_credential_id: string;
|
|
2429
|
+
acs_user_id?: string | undefined;
|
|
2430
|
+
acs_credential_pool_id?: string | undefined;
|
|
2431
|
+
acs_system_id: string;
|
|
2432
|
+
parent_acs_credential_id?: string | undefined;
|
|
2433
|
+
display_name: string;
|
|
2434
|
+
code?: (string | undefined) | null;
|
|
2435
|
+
card_number?: (string | undefined) | null;
|
|
2436
|
+
is_issued?: boolean | undefined;
|
|
2437
|
+
issued_at?: (string | undefined) | null;
|
|
2438
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
2439
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
2440
|
+
external_type_display_name?: string | undefined;
|
|
2441
|
+
created_at: string;
|
|
2442
|
+
workspace_id: string;
|
|
2443
|
+
starts_at?: string | undefined;
|
|
2444
|
+
ends_at?: string | undefined;
|
|
2445
|
+
errors: Array<{
|
|
2446
|
+
error_code: string;
|
|
2447
|
+
message: string;
|
|
2448
|
+
}>;
|
|
2449
|
+
warnings: Array<{
|
|
2450
|
+
warning_code: string;
|
|
2451
|
+
message: string;
|
|
2452
|
+
}>;
|
|
2453
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
2454
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
2455
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
2456
|
+
visionline_metadata?: {
|
|
2457
|
+
card_function_type: 'guest' | 'staff';
|
|
2458
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
2459
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
2460
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
2461
|
+
is_valid?: boolean | undefined;
|
|
2462
|
+
auto_join?: boolean | undefined;
|
|
2463
|
+
card_id?: string | undefined;
|
|
2464
|
+
credential_id?: string | undefined;
|
|
2465
|
+
} | undefined;
|
|
2466
|
+
is_managed: false;
|
|
2467
|
+
}) | null;
|
|
2048
2468
|
};
|
|
2049
2469
|
} | {
|
|
2050
2470
|
/** The ID of the action attempt. */
|
|
2051
2471
|
action_attempt_id: string;
|
|
2052
2472
|
status: 'error';
|
|
2053
2473
|
result: null;
|
|
2054
|
-
action_type: '
|
|
2474
|
+
action_type: 'SCAN_CARD';
|
|
2055
2475
|
error: {
|
|
2056
2476
|
type: 'no_card_on_encoder';
|
|
2057
2477
|
message: string;
|
|
@@ -3370,23 +3790,128 @@ export interface Routes {
|
|
|
3370
3790
|
status: 'pending';
|
|
3371
3791
|
result: null;
|
|
3372
3792
|
error: null;
|
|
3373
|
-
action_type: '
|
|
3793
|
+
action_type: 'SCAN_CARD';
|
|
3374
3794
|
} | {
|
|
3375
3795
|
/** The ID of the action attempt. */
|
|
3376
3796
|
action_attempt_id: string;
|
|
3377
3797
|
status: 'success';
|
|
3378
3798
|
error: null;
|
|
3379
|
-
action_type: '
|
|
3799
|
+
action_type: 'SCAN_CARD';
|
|
3380
3800
|
result: {
|
|
3381
|
-
/**
|
|
3382
|
-
|
|
3801
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
3802
|
+
acs_credential_on_encoder: {
|
|
3803
|
+
/** Date and time the credential was created. */
|
|
3804
|
+
created_at: string;
|
|
3805
|
+
is_issued: boolean | null;
|
|
3806
|
+
/** Date and time the credential will become useable. */
|
|
3807
|
+
starts_at: string | null;
|
|
3808
|
+
/** Date and time the credential will stop being useable. */
|
|
3809
|
+
ends_at: string | null;
|
|
3810
|
+
/** A number or string that physically identifies this card. */
|
|
3811
|
+
card_number: string | null;
|
|
3812
|
+
visionline_metadata?: {
|
|
3813
|
+
card_id: string;
|
|
3814
|
+
card_function_type: 'guest' | 'staff';
|
|
3815
|
+
cancelled: boolean;
|
|
3816
|
+
discarded: boolean;
|
|
3817
|
+
expired: boolean;
|
|
3818
|
+
overwritten: boolean;
|
|
3819
|
+
overridden?: boolean | undefined;
|
|
3820
|
+
pending_auto_update: boolean;
|
|
3821
|
+
card_format: 'TLCode' | 'rfid48';
|
|
3822
|
+
card_holder?: string | undefined;
|
|
3823
|
+
number_of_issued_cards: number;
|
|
3824
|
+
} | undefined;
|
|
3825
|
+
};
|
|
3826
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
3827
|
+
acs_credential_on_seam: ({
|
|
3828
|
+
acs_credential_id: string;
|
|
3829
|
+
acs_user_id?: string | undefined;
|
|
3830
|
+
acs_credential_pool_id?: string | undefined;
|
|
3831
|
+
acs_system_id: string;
|
|
3832
|
+
parent_acs_credential_id?: string | undefined;
|
|
3833
|
+
display_name: string;
|
|
3834
|
+
code?: (string | undefined) | null;
|
|
3835
|
+
card_number?: (string | undefined) | null;
|
|
3836
|
+
is_issued?: boolean | undefined;
|
|
3837
|
+
issued_at?: (string | undefined) | null;
|
|
3838
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
3839
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
3840
|
+
external_type_display_name?: string | undefined;
|
|
3841
|
+
created_at: string;
|
|
3842
|
+
workspace_id: string;
|
|
3843
|
+
starts_at?: string | undefined;
|
|
3844
|
+
ends_at?: string | undefined;
|
|
3845
|
+
errors: Array<{
|
|
3846
|
+
error_code: string;
|
|
3847
|
+
message: string;
|
|
3848
|
+
}>;
|
|
3849
|
+
warnings: Array<{
|
|
3850
|
+
warning_code: string;
|
|
3851
|
+
message: string;
|
|
3852
|
+
}>;
|
|
3853
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
3854
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
3855
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
3856
|
+
visionline_metadata?: {
|
|
3857
|
+
card_function_type: 'guest' | 'staff';
|
|
3858
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
3859
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
3860
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
3861
|
+
is_valid?: boolean | undefined;
|
|
3862
|
+
auto_join?: boolean | undefined;
|
|
3863
|
+
card_id?: string | undefined;
|
|
3864
|
+
credential_id?: string | undefined;
|
|
3865
|
+
} | undefined;
|
|
3866
|
+
is_managed: true;
|
|
3867
|
+
} | {
|
|
3868
|
+
acs_credential_id: string;
|
|
3869
|
+
acs_user_id?: string | undefined;
|
|
3870
|
+
acs_credential_pool_id?: string | undefined;
|
|
3871
|
+
acs_system_id: string;
|
|
3872
|
+
parent_acs_credential_id?: string | undefined;
|
|
3873
|
+
display_name: string;
|
|
3874
|
+
code?: (string | undefined) | null;
|
|
3875
|
+
card_number?: (string | undefined) | null;
|
|
3876
|
+
is_issued?: boolean | undefined;
|
|
3877
|
+
issued_at?: (string | undefined) | null;
|
|
3878
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
3879
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
3880
|
+
external_type_display_name?: string | undefined;
|
|
3881
|
+
created_at: string;
|
|
3882
|
+
workspace_id: string;
|
|
3883
|
+
starts_at?: string | undefined;
|
|
3884
|
+
ends_at?: string | undefined;
|
|
3885
|
+
errors: Array<{
|
|
3886
|
+
error_code: string;
|
|
3887
|
+
message: string;
|
|
3888
|
+
}>;
|
|
3889
|
+
warnings: Array<{
|
|
3890
|
+
warning_code: string;
|
|
3891
|
+
message: string;
|
|
3892
|
+
}>;
|
|
3893
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
3894
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
3895
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
3896
|
+
visionline_metadata?: {
|
|
3897
|
+
card_function_type: 'guest' | 'staff';
|
|
3898
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
3899
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
3900
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
3901
|
+
is_valid?: boolean | undefined;
|
|
3902
|
+
auto_join?: boolean | undefined;
|
|
3903
|
+
card_id?: string | undefined;
|
|
3904
|
+
credential_id?: string | undefined;
|
|
3905
|
+
} | undefined;
|
|
3906
|
+
is_managed: false;
|
|
3907
|
+
}) | null;
|
|
3383
3908
|
};
|
|
3384
3909
|
} | {
|
|
3385
3910
|
/** The ID of the action attempt. */
|
|
3386
3911
|
action_attempt_id: string;
|
|
3387
3912
|
status: 'error';
|
|
3388
3913
|
result: null;
|
|
3389
|
-
action_type: '
|
|
3914
|
+
action_type: 'SCAN_CARD';
|
|
3390
3915
|
error: {
|
|
3391
3916
|
type: 'no_card_on_encoder';
|
|
3392
3917
|
message: string;
|
|
@@ -4218,8 +4743,8 @@ export interface Routes {
|
|
|
4218
4743
|
}>;
|
|
4219
4744
|
};
|
|
4220
4745
|
};
|
|
4221
|
-
'/acs/encoders/
|
|
4222
|
-
route: '/acs/encoders/
|
|
4746
|
+
'/acs/encoders/scan_card': {
|
|
4747
|
+
route: '/acs/encoders/scan_card';
|
|
4223
4748
|
method: 'POST';
|
|
4224
4749
|
queryParams: {};
|
|
4225
4750
|
jsonBody: {};
|
|
@@ -4286,23 +4811,128 @@ export interface Routes {
|
|
|
4286
4811
|
status: 'pending';
|
|
4287
4812
|
result: null;
|
|
4288
4813
|
error: null;
|
|
4289
|
-
action_type: '
|
|
4814
|
+
action_type: 'SCAN_CARD';
|
|
4290
4815
|
} | {
|
|
4291
4816
|
/** The ID of the action attempt. */
|
|
4292
4817
|
action_attempt_id: string;
|
|
4293
4818
|
status: 'success';
|
|
4294
4819
|
error: null;
|
|
4295
|
-
action_type: '
|
|
4820
|
+
action_type: 'SCAN_CARD';
|
|
4296
4821
|
result: {
|
|
4297
|
-
/**
|
|
4298
|
-
|
|
4822
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
4823
|
+
acs_credential_on_encoder: {
|
|
4824
|
+
/** Date and time the credential was created. */
|
|
4825
|
+
created_at: string;
|
|
4826
|
+
is_issued: boolean | null;
|
|
4827
|
+
/** Date and time the credential will become useable. */
|
|
4828
|
+
starts_at: string | null;
|
|
4829
|
+
/** Date and time the credential will stop being useable. */
|
|
4830
|
+
ends_at: string | null;
|
|
4831
|
+
/** A number or string that physically identifies this card. */
|
|
4832
|
+
card_number: string | null;
|
|
4833
|
+
visionline_metadata?: {
|
|
4834
|
+
card_id: string;
|
|
4835
|
+
card_function_type: 'guest' | 'staff';
|
|
4836
|
+
cancelled: boolean;
|
|
4837
|
+
discarded: boolean;
|
|
4838
|
+
expired: boolean;
|
|
4839
|
+
overwritten: boolean;
|
|
4840
|
+
overridden?: boolean | undefined;
|
|
4841
|
+
pending_auto_update: boolean;
|
|
4842
|
+
card_format: 'TLCode' | 'rfid48';
|
|
4843
|
+
card_holder?: string | undefined;
|
|
4844
|
+
number_of_issued_cards: number;
|
|
4845
|
+
} | undefined;
|
|
4846
|
+
};
|
|
4847
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
4848
|
+
acs_credential_on_seam: ({
|
|
4849
|
+
acs_credential_id: string;
|
|
4850
|
+
acs_user_id?: string | undefined;
|
|
4851
|
+
acs_credential_pool_id?: string | undefined;
|
|
4852
|
+
acs_system_id: string;
|
|
4853
|
+
parent_acs_credential_id?: string | undefined;
|
|
4854
|
+
display_name: string;
|
|
4855
|
+
code?: (string | undefined) | null;
|
|
4856
|
+
card_number?: (string | undefined) | null;
|
|
4857
|
+
is_issued?: boolean | undefined;
|
|
4858
|
+
issued_at?: (string | undefined) | null;
|
|
4859
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
4860
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
4861
|
+
external_type_display_name?: string | undefined;
|
|
4862
|
+
created_at: string;
|
|
4863
|
+
workspace_id: string;
|
|
4864
|
+
starts_at?: string | undefined;
|
|
4865
|
+
ends_at?: string | undefined;
|
|
4866
|
+
errors: Array<{
|
|
4867
|
+
error_code: string;
|
|
4868
|
+
message: string;
|
|
4869
|
+
}>;
|
|
4870
|
+
warnings: Array<{
|
|
4871
|
+
warning_code: string;
|
|
4872
|
+
message: string;
|
|
4873
|
+
}>;
|
|
4874
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
4875
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
4876
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
4877
|
+
visionline_metadata?: {
|
|
4878
|
+
card_function_type: 'guest' | 'staff';
|
|
4879
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
4880
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
4881
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
4882
|
+
is_valid?: boolean | undefined;
|
|
4883
|
+
auto_join?: boolean | undefined;
|
|
4884
|
+
card_id?: string | undefined;
|
|
4885
|
+
credential_id?: string | undefined;
|
|
4886
|
+
} | undefined;
|
|
4887
|
+
is_managed: true;
|
|
4888
|
+
} | {
|
|
4889
|
+
acs_credential_id: string;
|
|
4890
|
+
acs_user_id?: string | undefined;
|
|
4891
|
+
acs_credential_pool_id?: string | undefined;
|
|
4892
|
+
acs_system_id: string;
|
|
4893
|
+
parent_acs_credential_id?: string | undefined;
|
|
4894
|
+
display_name: string;
|
|
4895
|
+
code?: (string | undefined) | null;
|
|
4896
|
+
card_number?: (string | undefined) | null;
|
|
4897
|
+
is_issued?: boolean | undefined;
|
|
4898
|
+
issued_at?: (string | undefined) | null;
|
|
4899
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
4900
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
4901
|
+
external_type_display_name?: string | undefined;
|
|
4902
|
+
created_at: string;
|
|
4903
|
+
workspace_id: string;
|
|
4904
|
+
starts_at?: string | undefined;
|
|
4905
|
+
ends_at?: string | undefined;
|
|
4906
|
+
errors: Array<{
|
|
4907
|
+
error_code: string;
|
|
4908
|
+
message: string;
|
|
4909
|
+
}>;
|
|
4910
|
+
warnings: Array<{
|
|
4911
|
+
warning_code: string;
|
|
4912
|
+
message: string;
|
|
4913
|
+
}>;
|
|
4914
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
4915
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
4916
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
4917
|
+
visionline_metadata?: {
|
|
4918
|
+
card_function_type: 'guest' | 'staff';
|
|
4919
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
4920
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
4921
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
4922
|
+
is_valid?: boolean | undefined;
|
|
4923
|
+
auto_join?: boolean | undefined;
|
|
4924
|
+
card_id?: string | undefined;
|
|
4925
|
+
credential_id?: string | undefined;
|
|
4926
|
+
} | undefined;
|
|
4927
|
+
is_managed: false;
|
|
4928
|
+
}) | null;
|
|
4299
4929
|
};
|
|
4300
4930
|
} | {
|
|
4301
4931
|
/** The ID of the action attempt. */
|
|
4302
4932
|
action_attempt_id: string;
|
|
4303
4933
|
status: 'error';
|
|
4304
4934
|
result: null;
|
|
4305
|
-
action_type: '
|
|
4935
|
+
action_type: 'SCAN_CARD';
|
|
4306
4936
|
error: {
|
|
4307
4937
|
type: 'no_card_on_encoder';
|
|
4308
4938
|
message: string;
|
|
@@ -5897,23 +6527,128 @@ export interface Routes {
|
|
|
5897
6527
|
status: 'pending';
|
|
5898
6528
|
result: null;
|
|
5899
6529
|
error: null;
|
|
5900
|
-
action_type: '
|
|
6530
|
+
action_type: 'SCAN_CARD';
|
|
5901
6531
|
} | {
|
|
5902
6532
|
/** The ID of the action attempt. */
|
|
5903
6533
|
action_attempt_id: string;
|
|
5904
6534
|
status: 'success';
|
|
5905
6535
|
error: null;
|
|
5906
|
-
action_type: '
|
|
6536
|
+
action_type: 'SCAN_CARD';
|
|
5907
6537
|
result: {
|
|
5908
|
-
/**
|
|
5909
|
-
|
|
6538
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
6539
|
+
acs_credential_on_encoder: {
|
|
6540
|
+
/** Date and time the credential was created. */
|
|
6541
|
+
created_at: string;
|
|
6542
|
+
is_issued: boolean | null;
|
|
6543
|
+
/** Date and time the credential will become useable. */
|
|
6544
|
+
starts_at: string | null;
|
|
6545
|
+
/** Date and time the credential will stop being useable. */
|
|
6546
|
+
ends_at: string | null;
|
|
6547
|
+
/** A number or string that physically identifies this card. */
|
|
6548
|
+
card_number: string | null;
|
|
6549
|
+
visionline_metadata?: {
|
|
6550
|
+
card_id: string;
|
|
6551
|
+
card_function_type: 'guest' | 'staff';
|
|
6552
|
+
cancelled: boolean;
|
|
6553
|
+
discarded: boolean;
|
|
6554
|
+
expired: boolean;
|
|
6555
|
+
overwritten: boolean;
|
|
6556
|
+
overridden?: boolean | undefined;
|
|
6557
|
+
pending_auto_update: boolean;
|
|
6558
|
+
card_format: 'TLCode' | 'rfid48';
|
|
6559
|
+
card_holder?: string | undefined;
|
|
6560
|
+
number_of_issued_cards: number;
|
|
6561
|
+
} | undefined;
|
|
6562
|
+
};
|
|
6563
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
6564
|
+
acs_credential_on_seam: ({
|
|
6565
|
+
acs_credential_id: string;
|
|
6566
|
+
acs_user_id?: string | undefined;
|
|
6567
|
+
acs_credential_pool_id?: string | undefined;
|
|
6568
|
+
acs_system_id: string;
|
|
6569
|
+
parent_acs_credential_id?: string | undefined;
|
|
6570
|
+
display_name: string;
|
|
6571
|
+
code?: (string | undefined) | null;
|
|
6572
|
+
card_number?: (string | undefined) | null;
|
|
6573
|
+
is_issued?: boolean | undefined;
|
|
6574
|
+
issued_at?: (string | undefined) | null;
|
|
6575
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
6576
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
6577
|
+
external_type_display_name?: string | undefined;
|
|
6578
|
+
created_at: string;
|
|
6579
|
+
workspace_id: string;
|
|
6580
|
+
starts_at?: string | undefined;
|
|
6581
|
+
ends_at?: string | undefined;
|
|
6582
|
+
errors: Array<{
|
|
6583
|
+
error_code: string;
|
|
6584
|
+
message: string;
|
|
6585
|
+
}>;
|
|
6586
|
+
warnings: Array<{
|
|
6587
|
+
warning_code: string;
|
|
6588
|
+
message: string;
|
|
6589
|
+
}>;
|
|
6590
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
6591
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
6592
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
6593
|
+
visionline_metadata?: {
|
|
6594
|
+
card_function_type: 'guest' | 'staff';
|
|
6595
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
6596
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
6597
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
6598
|
+
is_valid?: boolean | undefined;
|
|
6599
|
+
auto_join?: boolean | undefined;
|
|
6600
|
+
card_id?: string | undefined;
|
|
6601
|
+
credential_id?: string | undefined;
|
|
6602
|
+
} | undefined;
|
|
6603
|
+
is_managed: true;
|
|
6604
|
+
} | {
|
|
6605
|
+
acs_credential_id: string;
|
|
6606
|
+
acs_user_id?: string | undefined;
|
|
6607
|
+
acs_credential_pool_id?: string | undefined;
|
|
6608
|
+
acs_system_id: string;
|
|
6609
|
+
parent_acs_credential_id?: string | undefined;
|
|
6610
|
+
display_name: string;
|
|
6611
|
+
code?: (string | undefined) | null;
|
|
6612
|
+
card_number?: (string | undefined) | null;
|
|
6613
|
+
is_issued?: boolean | undefined;
|
|
6614
|
+
issued_at?: (string | undefined) | null;
|
|
6615
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
6616
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
6617
|
+
external_type_display_name?: string | undefined;
|
|
6618
|
+
created_at: string;
|
|
6619
|
+
workspace_id: string;
|
|
6620
|
+
starts_at?: string | undefined;
|
|
6621
|
+
ends_at?: string | undefined;
|
|
6622
|
+
errors: Array<{
|
|
6623
|
+
error_code: string;
|
|
6624
|
+
message: string;
|
|
6625
|
+
}>;
|
|
6626
|
+
warnings: Array<{
|
|
6627
|
+
warning_code: string;
|
|
6628
|
+
message: string;
|
|
6629
|
+
}>;
|
|
6630
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
6631
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
6632
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
6633
|
+
visionline_metadata?: {
|
|
6634
|
+
card_function_type: 'guest' | 'staff';
|
|
6635
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
6636
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
6637
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
6638
|
+
is_valid?: boolean | undefined;
|
|
6639
|
+
auto_join?: boolean | undefined;
|
|
6640
|
+
card_id?: string | undefined;
|
|
6641
|
+
credential_id?: string | undefined;
|
|
6642
|
+
} | undefined;
|
|
6643
|
+
is_managed: false;
|
|
6644
|
+
}) | null;
|
|
5910
6645
|
};
|
|
5911
6646
|
} | {
|
|
5912
6647
|
/** The ID of the action attempt. */
|
|
5913
6648
|
action_attempt_id: string;
|
|
5914
6649
|
status: 'error';
|
|
5915
6650
|
result: null;
|
|
5916
|
-
action_type: '
|
|
6651
|
+
action_type: 'SCAN_CARD';
|
|
5917
6652
|
error: {
|
|
5918
6653
|
type: 'no_card_on_encoder';
|
|
5919
6654
|
message: string;
|
|
@@ -6350,23 +7085,128 @@ export interface Routes {
|
|
|
6350
7085
|
status: 'pending';
|
|
6351
7086
|
result: null;
|
|
6352
7087
|
error: null;
|
|
6353
|
-
action_type: '
|
|
7088
|
+
action_type: 'SCAN_CARD';
|
|
6354
7089
|
} | {
|
|
6355
7090
|
/** The ID of the action attempt. */
|
|
6356
7091
|
action_attempt_id: string;
|
|
6357
7092
|
status: 'success';
|
|
6358
7093
|
error: null;
|
|
6359
|
-
action_type: '
|
|
7094
|
+
action_type: 'SCAN_CARD';
|
|
6360
7095
|
result: {
|
|
6361
|
-
/**
|
|
6362
|
-
|
|
7096
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
7097
|
+
acs_credential_on_encoder: {
|
|
7098
|
+
/** Date and time the credential was created. */
|
|
7099
|
+
created_at: string;
|
|
7100
|
+
is_issued: boolean | null;
|
|
7101
|
+
/** Date and time the credential will become useable. */
|
|
7102
|
+
starts_at: string | null;
|
|
7103
|
+
/** Date and time the credential will stop being useable. */
|
|
7104
|
+
ends_at: string | null;
|
|
7105
|
+
/** A number or string that physically identifies this card. */
|
|
7106
|
+
card_number: string | null;
|
|
7107
|
+
visionline_metadata?: {
|
|
7108
|
+
card_id: string;
|
|
7109
|
+
card_function_type: 'guest' | 'staff';
|
|
7110
|
+
cancelled: boolean;
|
|
7111
|
+
discarded: boolean;
|
|
7112
|
+
expired: boolean;
|
|
7113
|
+
overwritten: boolean;
|
|
7114
|
+
overridden?: boolean | undefined;
|
|
7115
|
+
pending_auto_update: boolean;
|
|
7116
|
+
card_format: 'TLCode' | 'rfid48';
|
|
7117
|
+
card_holder?: string | undefined;
|
|
7118
|
+
number_of_issued_cards: number;
|
|
7119
|
+
} | undefined;
|
|
7120
|
+
};
|
|
7121
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
7122
|
+
acs_credential_on_seam: ({
|
|
7123
|
+
acs_credential_id: string;
|
|
7124
|
+
acs_user_id?: string | undefined;
|
|
7125
|
+
acs_credential_pool_id?: string | undefined;
|
|
7126
|
+
acs_system_id: string;
|
|
7127
|
+
parent_acs_credential_id?: string | undefined;
|
|
7128
|
+
display_name: string;
|
|
7129
|
+
code?: (string | undefined) | null;
|
|
7130
|
+
card_number?: (string | undefined) | null;
|
|
7131
|
+
is_issued?: boolean | undefined;
|
|
7132
|
+
issued_at?: (string | undefined) | null;
|
|
7133
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
7134
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
7135
|
+
external_type_display_name?: string | undefined;
|
|
7136
|
+
created_at: string;
|
|
7137
|
+
workspace_id: string;
|
|
7138
|
+
starts_at?: string | undefined;
|
|
7139
|
+
ends_at?: string | undefined;
|
|
7140
|
+
errors: Array<{
|
|
7141
|
+
error_code: string;
|
|
7142
|
+
message: string;
|
|
7143
|
+
}>;
|
|
7144
|
+
warnings: Array<{
|
|
7145
|
+
warning_code: string;
|
|
7146
|
+
message: string;
|
|
7147
|
+
}>;
|
|
7148
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
7149
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
7150
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
7151
|
+
visionline_metadata?: {
|
|
7152
|
+
card_function_type: 'guest' | 'staff';
|
|
7153
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
7154
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
7155
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
7156
|
+
is_valid?: boolean | undefined;
|
|
7157
|
+
auto_join?: boolean | undefined;
|
|
7158
|
+
card_id?: string | undefined;
|
|
7159
|
+
credential_id?: string | undefined;
|
|
7160
|
+
} | undefined;
|
|
7161
|
+
is_managed: true;
|
|
7162
|
+
} | {
|
|
7163
|
+
acs_credential_id: string;
|
|
7164
|
+
acs_user_id?: string | undefined;
|
|
7165
|
+
acs_credential_pool_id?: string | undefined;
|
|
7166
|
+
acs_system_id: string;
|
|
7167
|
+
parent_acs_credential_id?: string | undefined;
|
|
7168
|
+
display_name: string;
|
|
7169
|
+
code?: (string | undefined) | null;
|
|
7170
|
+
card_number?: (string | undefined) | null;
|
|
7171
|
+
is_issued?: boolean | undefined;
|
|
7172
|
+
issued_at?: (string | undefined) | null;
|
|
7173
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
7174
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
7175
|
+
external_type_display_name?: string | undefined;
|
|
7176
|
+
created_at: string;
|
|
7177
|
+
workspace_id: string;
|
|
7178
|
+
starts_at?: string | undefined;
|
|
7179
|
+
ends_at?: string | undefined;
|
|
7180
|
+
errors: Array<{
|
|
7181
|
+
error_code: string;
|
|
7182
|
+
message: string;
|
|
7183
|
+
}>;
|
|
7184
|
+
warnings: Array<{
|
|
7185
|
+
warning_code: string;
|
|
7186
|
+
message: string;
|
|
7187
|
+
}>;
|
|
7188
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
7189
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
7190
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
7191
|
+
visionline_metadata?: {
|
|
7192
|
+
card_function_type: 'guest' | 'staff';
|
|
7193
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
7194
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
7195
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
7196
|
+
is_valid?: boolean | undefined;
|
|
7197
|
+
auto_join?: boolean | undefined;
|
|
7198
|
+
card_id?: string | undefined;
|
|
7199
|
+
credential_id?: string | undefined;
|
|
7200
|
+
} | undefined;
|
|
7201
|
+
is_managed: false;
|
|
7202
|
+
}) | null;
|
|
6363
7203
|
};
|
|
6364
7204
|
} | {
|
|
6365
7205
|
/** The ID of the action attempt. */
|
|
6366
7206
|
action_attempt_id: string;
|
|
6367
7207
|
status: 'error';
|
|
6368
7208
|
result: null;
|
|
6369
|
-
action_type: '
|
|
7209
|
+
action_type: 'SCAN_CARD';
|
|
6370
7210
|
error: {
|
|
6371
7211
|
type: 'no_card_on_encoder';
|
|
6372
7212
|
message: string;
|
|
@@ -10349,23 +11189,128 @@ export interface Routes {
|
|
|
10349
11189
|
status: 'pending';
|
|
10350
11190
|
result: null;
|
|
10351
11191
|
error: null;
|
|
10352
|
-
action_type: '
|
|
11192
|
+
action_type: 'SCAN_CARD';
|
|
10353
11193
|
} | {
|
|
10354
11194
|
/** The ID of the action attempt. */
|
|
10355
11195
|
action_attempt_id: string;
|
|
10356
11196
|
status: 'success';
|
|
10357
11197
|
error: null;
|
|
10358
|
-
action_type: '
|
|
11198
|
+
action_type: 'SCAN_CARD';
|
|
10359
11199
|
result: {
|
|
10360
|
-
/**
|
|
10361
|
-
|
|
11200
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
11201
|
+
acs_credential_on_encoder: {
|
|
11202
|
+
/** Date and time the credential was created. */
|
|
11203
|
+
created_at: string;
|
|
11204
|
+
is_issued: boolean | null;
|
|
11205
|
+
/** Date and time the credential will become useable. */
|
|
11206
|
+
starts_at: string | null;
|
|
11207
|
+
/** Date and time the credential will stop being useable. */
|
|
11208
|
+
ends_at: string | null;
|
|
11209
|
+
/** A number or string that physically identifies this card. */
|
|
11210
|
+
card_number: string | null;
|
|
11211
|
+
visionline_metadata?: {
|
|
11212
|
+
card_id: string;
|
|
11213
|
+
card_function_type: 'guest' | 'staff';
|
|
11214
|
+
cancelled: boolean;
|
|
11215
|
+
discarded: boolean;
|
|
11216
|
+
expired: boolean;
|
|
11217
|
+
overwritten: boolean;
|
|
11218
|
+
overridden?: boolean | undefined;
|
|
11219
|
+
pending_auto_update: boolean;
|
|
11220
|
+
card_format: 'TLCode' | 'rfid48';
|
|
11221
|
+
card_holder?: string | undefined;
|
|
11222
|
+
number_of_issued_cards: number;
|
|
11223
|
+
} | undefined;
|
|
11224
|
+
};
|
|
11225
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
11226
|
+
acs_credential_on_seam: ({
|
|
11227
|
+
acs_credential_id: string;
|
|
11228
|
+
acs_user_id?: string | undefined;
|
|
11229
|
+
acs_credential_pool_id?: string | undefined;
|
|
11230
|
+
acs_system_id: string;
|
|
11231
|
+
parent_acs_credential_id?: string | undefined;
|
|
11232
|
+
display_name: string;
|
|
11233
|
+
code?: (string | undefined) | null;
|
|
11234
|
+
card_number?: (string | undefined) | null;
|
|
11235
|
+
is_issued?: boolean | undefined;
|
|
11236
|
+
issued_at?: (string | undefined) | null;
|
|
11237
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
11238
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
11239
|
+
external_type_display_name?: string | undefined;
|
|
11240
|
+
created_at: string;
|
|
11241
|
+
workspace_id: string;
|
|
11242
|
+
starts_at?: string | undefined;
|
|
11243
|
+
ends_at?: string | undefined;
|
|
11244
|
+
errors: Array<{
|
|
11245
|
+
error_code: string;
|
|
11246
|
+
message: string;
|
|
11247
|
+
}>;
|
|
11248
|
+
warnings: Array<{
|
|
11249
|
+
warning_code: string;
|
|
11250
|
+
message: string;
|
|
11251
|
+
}>;
|
|
11252
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
11253
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
11254
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
11255
|
+
visionline_metadata?: {
|
|
11256
|
+
card_function_type: 'guest' | 'staff';
|
|
11257
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
11258
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
11259
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
11260
|
+
is_valid?: boolean | undefined;
|
|
11261
|
+
auto_join?: boolean | undefined;
|
|
11262
|
+
card_id?: string | undefined;
|
|
11263
|
+
credential_id?: string | undefined;
|
|
11264
|
+
} | undefined;
|
|
11265
|
+
is_managed: true;
|
|
11266
|
+
} | {
|
|
11267
|
+
acs_credential_id: string;
|
|
11268
|
+
acs_user_id?: string | undefined;
|
|
11269
|
+
acs_credential_pool_id?: string | undefined;
|
|
11270
|
+
acs_system_id: string;
|
|
11271
|
+
parent_acs_credential_id?: string | undefined;
|
|
11272
|
+
display_name: string;
|
|
11273
|
+
code?: (string | undefined) | null;
|
|
11274
|
+
card_number?: (string | undefined) | null;
|
|
11275
|
+
is_issued?: boolean | undefined;
|
|
11276
|
+
issued_at?: (string | undefined) | null;
|
|
11277
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
11278
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
11279
|
+
external_type_display_name?: string | undefined;
|
|
11280
|
+
created_at: string;
|
|
11281
|
+
workspace_id: string;
|
|
11282
|
+
starts_at?: string | undefined;
|
|
11283
|
+
ends_at?: string | undefined;
|
|
11284
|
+
errors: Array<{
|
|
11285
|
+
error_code: string;
|
|
11286
|
+
message: string;
|
|
11287
|
+
}>;
|
|
11288
|
+
warnings: Array<{
|
|
11289
|
+
warning_code: string;
|
|
11290
|
+
message: string;
|
|
11291
|
+
}>;
|
|
11292
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
11293
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
11294
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
11295
|
+
visionline_metadata?: {
|
|
11296
|
+
card_function_type: 'guest' | 'staff';
|
|
11297
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
11298
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
11299
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
11300
|
+
is_valid?: boolean | undefined;
|
|
11301
|
+
auto_join?: boolean | undefined;
|
|
11302
|
+
card_id?: string | undefined;
|
|
11303
|
+
credential_id?: string | undefined;
|
|
11304
|
+
} | undefined;
|
|
11305
|
+
is_managed: false;
|
|
11306
|
+
}) | null;
|
|
10362
11307
|
};
|
|
10363
11308
|
} | {
|
|
10364
11309
|
/** The ID of the action attempt. */
|
|
10365
11310
|
action_attempt_id: string;
|
|
10366
11311
|
status: 'error';
|
|
10367
11312
|
result: null;
|
|
10368
|
-
action_type: '
|
|
11313
|
+
action_type: 'SCAN_CARD';
|
|
10369
11314
|
error: {
|
|
10370
11315
|
type: 'no_card_on_encoder';
|
|
10371
11316
|
message: string;
|
|
@@ -10803,23 +11748,128 @@ export interface Routes {
|
|
|
10803
11748
|
status: 'pending';
|
|
10804
11749
|
result: null;
|
|
10805
11750
|
error: null;
|
|
10806
|
-
action_type: '
|
|
11751
|
+
action_type: 'SCAN_CARD';
|
|
10807
11752
|
} | {
|
|
10808
11753
|
/** The ID of the action attempt. */
|
|
10809
11754
|
action_attempt_id: string;
|
|
10810
11755
|
status: 'success';
|
|
10811
11756
|
error: null;
|
|
10812
|
-
action_type: '
|
|
11757
|
+
action_type: 'SCAN_CARD';
|
|
10813
11758
|
result: {
|
|
10814
|
-
/**
|
|
10815
|
-
|
|
11759
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
11760
|
+
acs_credential_on_encoder: {
|
|
11761
|
+
/** Date and time the credential was created. */
|
|
11762
|
+
created_at: string;
|
|
11763
|
+
is_issued: boolean | null;
|
|
11764
|
+
/** Date and time the credential will become useable. */
|
|
11765
|
+
starts_at: string | null;
|
|
11766
|
+
/** Date and time the credential will stop being useable. */
|
|
11767
|
+
ends_at: string | null;
|
|
11768
|
+
/** A number or string that physically identifies this card. */
|
|
11769
|
+
card_number: string | null;
|
|
11770
|
+
visionline_metadata?: {
|
|
11771
|
+
card_id: string;
|
|
11772
|
+
card_function_type: 'guest' | 'staff';
|
|
11773
|
+
cancelled: boolean;
|
|
11774
|
+
discarded: boolean;
|
|
11775
|
+
expired: boolean;
|
|
11776
|
+
overwritten: boolean;
|
|
11777
|
+
overridden?: boolean | undefined;
|
|
11778
|
+
pending_auto_update: boolean;
|
|
11779
|
+
card_format: 'TLCode' | 'rfid48';
|
|
11780
|
+
card_holder?: string | undefined;
|
|
11781
|
+
number_of_issued_cards: number;
|
|
11782
|
+
} | undefined;
|
|
11783
|
+
};
|
|
11784
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
11785
|
+
acs_credential_on_seam: ({
|
|
11786
|
+
acs_credential_id: string;
|
|
11787
|
+
acs_user_id?: string | undefined;
|
|
11788
|
+
acs_credential_pool_id?: string | undefined;
|
|
11789
|
+
acs_system_id: string;
|
|
11790
|
+
parent_acs_credential_id?: string | undefined;
|
|
11791
|
+
display_name: string;
|
|
11792
|
+
code?: (string | undefined) | null;
|
|
11793
|
+
card_number?: (string | undefined) | null;
|
|
11794
|
+
is_issued?: boolean | undefined;
|
|
11795
|
+
issued_at?: (string | undefined) | null;
|
|
11796
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
11797
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
11798
|
+
external_type_display_name?: string | undefined;
|
|
11799
|
+
created_at: string;
|
|
11800
|
+
workspace_id: string;
|
|
11801
|
+
starts_at?: string | undefined;
|
|
11802
|
+
ends_at?: string | undefined;
|
|
11803
|
+
errors: Array<{
|
|
11804
|
+
error_code: string;
|
|
11805
|
+
message: string;
|
|
11806
|
+
}>;
|
|
11807
|
+
warnings: Array<{
|
|
11808
|
+
warning_code: string;
|
|
11809
|
+
message: string;
|
|
11810
|
+
}>;
|
|
11811
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
11812
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
11813
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
11814
|
+
visionline_metadata?: {
|
|
11815
|
+
card_function_type: 'guest' | 'staff';
|
|
11816
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
11817
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
11818
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
11819
|
+
is_valid?: boolean | undefined;
|
|
11820
|
+
auto_join?: boolean | undefined;
|
|
11821
|
+
card_id?: string | undefined;
|
|
11822
|
+
credential_id?: string | undefined;
|
|
11823
|
+
} | undefined;
|
|
11824
|
+
is_managed: true;
|
|
11825
|
+
} | {
|
|
11826
|
+
acs_credential_id: string;
|
|
11827
|
+
acs_user_id?: string | undefined;
|
|
11828
|
+
acs_credential_pool_id?: string | undefined;
|
|
11829
|
+
acs_system_id: string;
|
|
11830
|
+
parent_acs_credential_id?: string | undefined;
|
|
11831
|
+
display_name: string;
|
|
11832
|
+
code?: (string | undefined) | null;
|
|
11833
|
+
card_number?: (string | undefined) | null;
|
|
11834
|
+
is_issued?: boolean | undefined;
|
|
11835
|
+
issued_at?: (string | undefined) | null;
|
|
11836
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
11837
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
11838
|
+
external_type_display_name?: string | undefined;
|
|
11839
|
+
created_at: string;
|
|
11840
|
+
workspace_id: string;
|
|
11841
|
+
starts_at?: string | undefined;
|
|
11842
|
+
ends_at?: string | undefined;
|
|
11843
|
+
errors: Array<{
|
|
11844
|
+
error_code: string;
|
|
11845
|
+
message: string;
|
|
11846
|
+
}>;
|
|
11847
|
+
warnings: Array<{
|
|
11848
|
+
warning_code: string;
|
|
11849
|
+
message: string;
|
|
11850
|
+
}>;
|
|
11851
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
11852
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
11853
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
11854
|
+
visionline_metadata?: {
|
|
11855
|
+
card_function_type: 'guest' | 'staff';
|
|
11856
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
11857
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
11858
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
11859
|
+
is_valid?: boolean | undefined;
|
|
11860
|
+
auto_join?: boolean | undefined;
|
|
11861
|
+
card_id?: string | undefined;
|
|
11862
|
+
credential_id?: string | undefined;
|
|
11863
|
+
} | undefined;
|
|
11864
|
+
is_managed: false;
|
|
11865
|
+
}) | null;
|
|
10816
11866
|
};
|
|
10817
11867
|
} | {
|
|
10818
11868
|
/** The ID of the action attempt. */
|
|
10819
11869
|
action_attempt_id: string;
|
|
10820
11870
|
status: 'error';
|
|
10821
11871
|
result: null;
|
|
10822
|
-
action_type: '
|
|
11872
|
+
action_type: 'SCAN_CARD';
|
|
10823
11873
|
error: {
|
|
10824
11874
|
type: 'no_card_on_encoder';
|
|
10825
11875
|
message: string;
|
|
@@ -12199,23 +13249,128 @@ export interface Routes {
|
|
|
12199
13249
|
status: 'pending';
|
|
12200
13250
|
result: null;
|
|
12201
13251
|
error: null;
|
|
12202
|
-
action_type: '
|
|
13252
|
+
action_type: 'SCAN_CARD';
|
|
12203
13253
|
} | {
|
|
12204
13254
|
/** The ID of the action attempt. */
|
|
12205
13255
|
action_attempt_id: string;
|
|
12206
13256
|
status: 'success';
|
|
12207
13257
|
error: null;
|
|
12208
|
-
action_type: '
|
|
13258
|
+
action_type: 'SCAN_CARD';
|
|
12209
13259
|
result: {
|
|
12210
|
-
/**
|
|
12211
|
-
|
|
13260
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
13261
|
+
acs_credential_on_encoder: {
|
|
13262
|
+
/** Date and time the credential was created. */
|
|
13263
|
+
created_at: string;
|
|
13264
|
+
is_issued: boolean | null;
|
|
13265
|
+
/** Date and time the credential will become useable. */
|
|
13266
|
+
starts_at: string | null;
|
|
13267
|
+
/** Date and time the credential will stop being useable. */
|
|
13268
|
+
ends_at: string | null;
|
|
13269
|
+
/** A number or string that physically identifies this card. */
|
|
13270
|
+
card_number: string | null;
|
|
13271
|
+
visionline_metadata?: {
|
|
13272
|
+
card_id: string;
|
|
13273
|
+
card_function_type: 'guest' | 'staff';
|
|
13274
|
+
cancelled: boolean;
|
|
13275
|
+
discarded: boolean;
|
|
13276
|
+
expired: boolean;
|
|
13277
|
+
overwritten: boolean;
|
|
13278
|
+
overridden?: boolean | undefined;
|
|
13279
|
+
pending_auto_update: boolean;
|
|
13280
|
+
card_format: 'TLCode' | 'rfid48';
|
|
13281
|
+
card_holder?: string | undefined;
|
|
13282
|
+
number_of_issued_cards: number;
|
|
13283
|
+
} | undefined;
|
|
13284
|
+
};
|
|
13285
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
13286
|
+
acs_credential_on_seam: ({
|
|
13287
|
+
acs_credential_id: string;
|
|
13288
|
+
acs_user_id?: string | undefined;
|
|
13289
|
+
acs_credential_pool_id?: string | undefined;
|
|
13290
|
+
acs_system_id: string;
|
|
13291
|
+
parent_acs_credential_id?: string | undefined;
|
|
13292
|
+
display_name: string;
|
|
13293
|
+
code?: (string | undefined) | null;
|
|
13294
|
+
card_number?: (string | undefined) | null;
|
|
13295
|
+
is_issued?: boolean | undefined;
|
|
13296
|
+
issued_at?: (string | undefined) | null;
|
|
13297
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
13298
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
13299
|
+
external_type_display_name?: string | undefined;
|
|
13300
|
+
created_at: string;
|
|
13301
|
+
workspace_id: string;
|
|
13302
|
+
starts_at?: string | undefined;
|
|
13303
|
+
ends_at?: string | undefined;
|
|
13304
|
+
errors: Array<{
|
|
13305
|
+
error_code: string;
|
|
13306
|
+
message: string;
|
|
13307
|
+
}>;
|
|
13308
|
+
warnings: Array<{
|
|
13309
|
+
warning_code: string;
|
|
13310
|
+
message: string;
|
|
13311
|
+
}>;
|
|
13312
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
13313
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
13314
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
13315
|
+
visionline_metadata?: {
|
|
13316
|
+
card_function_type: 'guest' | 'staff';
|
|
13317
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
13318
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
13319
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
13320
|
+
is_valid?: boolean | undefined;
|
|
13321
|
+
auto_join?: boolean | undefined;
|
|
13322
|
+
card_id?: string | undefined;
|
|
13323
|
+
credential_id?: string | undefined;
|
|
13324
|
+
} | undefined;
|
|
13325
|
+
is_managed: true;
|
|
13326
|
+
} | {
|
|
13327
|
+
acs_credential_id: string;
|
|
13328
|
+
acs_user_id?: string | undefined;
|
|
13329
|
+
acs_credential_pool_id?: string | undefined;
|
|
13330
|
+
acs_system_id: string;
|
|
13331
|
+
parent_acs_credential_id?: string | undefined;
|
|
13332
|
+
display_name: string;
|
|
13333
|
+
code?: (string | undefined) | null;
|
|
13334
|
+
card_number?: (string | undefined) | null;
|
|
13335
|
+
is_issued?: boolean | undefined;
|
|
13336
|
+
issued_at?: (string | undefined) | null;
|
|
13337
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
13338
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
13339
|
+
external_type_display_name?: string | undefined;
|
|
13340
|
+
created_at: string;
|
|
13341
|
+
workspace_id: string;
|
|
13342
|
+
starts_at?: string | undefined;
|
|
13343
|
+
ends_at?: string | undefined;
|
|
13344
|
+
errors: Array<{
|
|
13345
|
+
error_code: string;
|
|
13346
|
+
message: string;
|
|
13347
|
+
}>;
|
|
13348
|
+
warnings: Array<{
|
|
13349
|
+
warning_code: string;
|
|
13350
|
+
message: string;
|
|
13351
|
+
}>;
|
|
13352
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
13353
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
13354
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
13355
|
+
visionline_metadata?: {
|
|
13356
|
+
card_function_type: 'guest' | 'staff';
|
|
13357
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
13358
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
13359
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
13360
|
+
is_valid?: boolean | undefined;
|
|
13361
|
+
auto_join?: boolean | undefined;
|
|
13362
|
+
card_id?: string | undefined;
|
|
13363
|
+
credential_id?: string | undefined;
|
|
13364
|
+
} | undefined;
|
|
13365
|
+
is_managed: false;
|
|
13366
|
+
}) | null;
|
|
12212
13367
|
};
|
|
12213
13368
|
} | {
|
|
12214
13369
|
/** The ID of the action attempt. */
|
|
12215
13370
|
action_attempt_id: string;
|
|
12216
13371
|
status: 'error';
|
|
12217
13372
|
result: null;
|
|
12218
|
-
action_type: '
|
|
13373
|
+
action_type: 'SCAN_CARD';
|
|
12219
13374
|
error: {
|
|
12220
13375
|
type: 'no_card_on_encoder';
|
|
12221
13376
|
message: string;
|
|
@@ -12663,23 +13818,128 @@ export interface Routes {
|
|
|
12663
13818
|
status: 'pending';
|
|
12664
13819
|
result: null;
|
|
12665
13820
|
error: null;
|
|
12666
|
-
action_type: '
|
|
13821
|
+
action_type: 'SCAN_CARD';
|
|
12667
13822
|
} | {
|
|
12668
13823
|
/** The ID of the action attempt. */
|
|
12669
13824
|
action_attempt_id: string;
|
|
12670
13825
|
status: 'success';
|
|
12671
13826
|
error: null;
|
|
12672
|
-
action_type: '
|
|
13827
|
+
action_type: 'SCAN_CARD';
|
|
12673
13828
|
result: {
|
|
12674
|
-
/**
|
|
12675
|
-
|
|
13829
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
13830
|
+
acs_credential_on_encoder: {
|
|
13831
|
+
/** Date and time the credential was created. */
|
|
13832
|
+
created_at: string;
|
|
13833
|
+
is_issued: boolean | null;
|
|
13834
|
+
/** Date and time the credential will become useable. */
|
|
13835
|
+
starts_at: string | null;
|
|
13836
|
+
/** Date and time the credential will stop being useable. */
|
|
13837
|
+
ends_at: string | null;
|
|
13838
|
+
/** A number or string that physically identifies this card. */
|
|
13839
|
+
card_number: string | null;
|
|
13840
|
+
visionline_metadata?: {
|
|
13841
|
+
card_id: string;
|
|
13842
|
+
card_function_type: 'guest' | 'staff';
|
|
13843
|
+
cancelled: boolean;
|
|
13844
|
+
discarded: boolean;
|
|
13845
|
+
expired: boolean;
|
|
13846
|
+
overwritten: boolean;
|
|
13847
|
+
overridden?: boolean | undefined;
|
|
13848
|
+
pending_auto_update: boolean;
|
|
13849
|
+
card_format: 'TLCode' | 'rfid48';
|
|
13850
|
+
card_holder?: string | undefined;
|
|
13851
|
+
number_of_issued_cards: number;
|
|
13852
|
+
} | undefined;
|
|
13853
|
+
};
|
|
13854
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
13855
|
+
acs_credential_on_seam: ({
|
|
13856
|
+
acs_credential_id: string;
|
|
13857
|
+
acs_user_id?: string | undefined;
|
|
13858
|
+
acs_credential_pool_id?: string | undefined;
|
|
13859
|
+
acs_system_id: string;
|
|
13860
|
+
parent_acs_credential_id?: string | undefined;
|
|
13861
|
+
display_name: string;
|
|
13862
|
+
code?: (string | undefined) | null;
|
|
13863
|
+
card_number?: (string | undefined) | null;
|
|
13864
|
+
is_issued?: boolean | undefined;
|
|
13865
|
+
issued_at?: (string | undefined) | null;
|
|
13866
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
13867
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
13868
|
+
external_type_display_name?: string | undefined;
|
|
13869
|
+
created_at: string;
|
|
13870
|
+
workspace_id: string;
|
|
13871
|
+
starts_at?: string | undefined;
|
|
13872
|
+
ends_at?: string | undefined;
|
|
13873
|
+
errors: Array<{
|
|
13874
|
+
error_code: string;
|
|
13875
|
+
message: string;
|
|
13876
|
+
}>;
|
|
13877
|
+
warnings: Array<{
|
|
13878
|
+
warning_code: string;
|
|
13879
|
+
message: string;
|
|
13880
|
+
}>;
|
|
13881
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
13882
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
13883
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
13884
|
+
visionline_metadata?: {
|
|
13885
|
+
card_function_type: 'guest' | 'staff';
|
|
13886
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
13887
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
13888
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
13889
|
+
is_valid?: boolean | undefined;
|
|
13890
|
+
auto_join?: boolean | undefined;
|
|
13891
|
+
card_id?: string | undefined;
|
|
13892
|
+
credential_id?: string | undefined;
|
|
13893
|
+
} | undefined;
|
|
13894
|
+
is_managed: true;
|
|
13895
|
+
} | {
|
|
13896
|
+
acs_credential_id: string;
|
|
13897
|
+
acs_user_id?: string | undefined;
|
|
13898
|
+
acs_credential_pool_id?: string | undefined;
|
|
13899
|
+
acs_system_id: string;
|
|
13900
|
+
parent_acs_credential_id?: string | undefined;
|
|
13901
|
+
display_name: string;
|
|
13902
|
+
code?: (string | undefined) | null;
|
|
13903
|
+
card_number?: (string | undefined) | null;
|
|
13904
|
+
is_issued?: boolean | undefined;
|
|
13905
|
+
issued_at?: (string | undefined) | null;
|
|
13906
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
13907
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
13908
|
+
external_type_display_name?: string | undefined;
|
|
13909
|
+
created_at: string;
|
|
13910
|
+
workspace_id: string;
|
|
13911
|
+
starts_at?: string | undefined;
|
|
13912
|
+
ends_at?: string | undefined;
|
|
13913
|
+
errors: Array<{
|
|
13914
|
+
error_code: string;
|
|
13915
|
+
message: string;
|
|
13916
|
+
}>;
|
|
13917
|
+
warnings: Array<{
|
|
13918
|
+
warning_code: string;
|
|
13919
|
+
message: string;
|
|
13920
|
+
}>;
|
|
13921
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
13922
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
13923
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
13924
|
+
visionline_metadata?: {
|
|
13925
|
+
card_function_type: 'guest' | 'staff';
|
|
13926
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
13927
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
13928
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
13929
|
+
is_valid?: boolean | undefined;
|
|
13930
|
+
auto_join?: boolean | undefined;
|
|
13931
|
+
card_id?: string | undefined;
|
|
13932
|
+
credential_id?: string | undefined;
|
|
13933
|
+
} | undefined;
|
|
13934
|
+
is_managed: false;
|
|
13935
|
+
}) | null;
|
|
12676
13936
|
};
|
|
12677
13937
|
} | {
|
|
12678
13938
|
/** The ID of the action attempt. */
|
|
12679
13939
|
action_attempt_id: string;
|
|
12680
13940
|
status: 'error';
|
|
12681
13941
|
result: null;
|
|
12682
|
-
action_type: '
|
|
13942
|
+
action_type: 'SCAN_CARD';
|
|
12683
13943
|
error: {
|
|
12684
13944
|
type: 'no_card_on_encoder';
|
|
12685
13945
|
message: string;
|
|
@@ -13166,23 +14426,128 @@ export interface Routes {
|
|
|
13166
14426
|
status: 'pending';
|
|
13167
14427
|
result: null;
|
|
13168
14428
|
error: null;
|
|
13169
|
-
action_type: '
|
|
14429
|
+
action_type: 'SCAN_CARD';
|
|
13170
14430
|
} | {
|
|
13171
14431
|
/** The ID of the action attempt. */
|
|
13172
14432
|
action_attempt_id: string;
|
|
13173
14433
|
status: 'success';
|
|
13174
14434
|
error: null;
|
|
13175
|
-
action_type: '
|
|
14435
|
+
action_type: 'SCAN_CARD';
|
|
13176
14436
|
result: {
|
|
13177
|
-
/**
|
|
13178
|
-
|
|
14437
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
14438
|
+
acs_credential_on_encoder: {
|
|
14439
|
+
/** Date and time the credential was created. */
|
|
14440
|
+
created_at: string;
|
|
14441
|
+
is_issued: boolean | null;
|
|
14442
|
+
/** Date and time the credential will become useable. */
|
|
14443
|
+
starts_at: string | null;
|
|
14444
|
+
/** Date and time the credential will stop being useable. */
|
|
14445
|
+
ends_at: string | null;
|
|
14446
|
+
/** A number or string that physically identifies this card. */
|
|
14447
|
+
card_number: string | null;
|
|
14448
|
+
visionline_metadata?: {
|
|
14449
|
+
card_id: string;
|
|
14450
|
+
card_function_type: 'guest' | 'staff';
|
|
14451
|
+
cancelled: boolean;
|
|
14452
|
+
discarded: boolean;
|
|
14453
|
+
expired: boolean;
|
|
14454
|
+
overwritten: boolean;
|
|
14455
|
+
overridden?: boolean | undefined;
|
|
14456
|
+
pending_auto_update: boolean;
|
|
14457
|
+
card_format: 'TLCode' | 'rfid48';
|
|
14458
|
+
card_holder?: string | undefined;
|
|
14459
|
+
number_of_issued_cards: number;
|
|
14460
|
+
} | undefined;
|
|
14461
|
+
};
|
|
14462
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
14463
|
+
acs_credential_on_seam: ({
|
|
14464
|
+
acs_credential_id: string;
|
|
14465
|
+
acs_user_id?: string | undefined;
|
|
14466
|
+
acs_credential_pool_id?: string | undefined;
|
|
14467
|
+
acs_system_id: string;
|
|
14468
|
+
parent_acs_credential_id?: string | undefined;
|
|
14469
|
+
display_name: string;
|
|
14470
|
+
code?: (string | undefined) | null;
|
|
14471
|
+
card_number?: (string | undefined) | null;
|
|
14472
|
+
is_issued?: boolean | undefined;
|
|
14473
|
+
issued_at?: (string | undefined) | null;
|
|
14474
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
14475
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
14476
|
+
external_type_display_name?: string | undefined;
|
|
14477
|
+
created_at: string;
|
|
14478
|
+
workspace_id: string;
|
|
14479
|
+
starts_at?: string | undefined;
|
|
14480
|
+
ends_at?: string | undefined;
|
|
14481
|
+
errors: Array<{
|
|
14482
|
+
error_code: string;
|
|
14483
|
+
message: string;
|
|
14484
|
+
}>;
|
|
14485
|
+
warnings: Array<{
|
|
14486
|
+
warning_code: string;
|
|
14487
|
+
message: string;
|
|
14488
|
+
}>;
|
|
14489
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
14490
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
14491
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
14492
|
+
visionline_metadata?: {
|
|
14493
|
+
card_function_type: 'guest' | 'staff';
|
|
14494
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
14495
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
14496
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
14497
|
+
is_valid?: boolean | undefined;
|
|
14498
|
+
auto_join?: boolean | undefined;
|
|
14499
|
+
card_id?: string | undefined;
|
|
14500
|
+
credential_id?: string | undefined;
|
|
14501
|
+
} | undefined;
|
|
14502
|
+
is_managed: true;
|
|
14503
|
+
} | {
|
|
14504
|
+
acs_credential_id: string;
|
|
14505
|
+
acs_user_id?: string | undefined;
|
|
14506
|
+
acs_credential_pool_id?: string | undefined;
|
|
14507
|
+
acs_system_id: string;
|
|
14508
|
+
parent_acs_credential_id?: string | undefined;
|
|
14509
|
+
display_name: string;
|
|
14510
|
+
code?: (string | undefined) | null;
|
|
14511
|
+
card_number?: (string | undefined) | null;
|
|
14512
|
+
is_issued?: boolean | undefined;
|
|
14513
|
+
issued_at?: (string | undefined) | null;
|
|
14514
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
14515
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
14516
|
+
external_type_display_name?: string | undefined;
|
|
14517
|
+
created_at: string;
|
|
14518
|
+
workspace_id: string;
|
|
14519
|
+
starts_at?: string | undefined;
|
|
14520
|
+
ends_at?: string | undefined;
|
|
14521
|
+
errors: Array<{
|
|
14522
|
+
error_code: string;
|
|
14523
|
+
message: string;
|
|
14524
|
+
}>;
|
|
14525
|
+
warnings: Array<{
|
|
14526
|
+
warning_code: string;
|
|
14527
|
+
message: string;
|
|
14528
|
+
}>;
|
|
14529
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
14530
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
14531
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
14532
|
+
visionline_metadata?: {
|
|
14533
|
+
card_function_type: 'guest' | 'staff';
|
|
14534
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
14535
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
14536
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
14537
|
+
is_valid?: boolean | undefined;
|
|
14538
|
+
auto_join?: boolean | undefined;
|
|
14539
|
+
card_id?: string | undefined;
|
|
14540
|
+
credential_id?: string | undefined;
|
|
14541
|
+
} | undefined;
|
|
14542
|
+
is_managed: false;
|
|
14543
|
+
}) | null;
|
|
13179
14544
|
};
|
|
13180
14545
|
} | {
|
|
13181
14546
|
/** The ID of the action attempt. */
|
|
13182
14547
|
action_attempt_id: string;
|
|
13183
14548
|
status: 'error';
|
|
13184
14549
|
result: null;
|
|
13185
|
-
action_type: '
|
|
14550
|
+
action_type: 'SCAN_CARD';
|
|
13186
14551
|
error: {
|
|
13187
14552
|
type: 'no_card_on_encoder';
|
|
13188
14553
|
message: string;
|
|
@@ -13802,23 +15167,128 @@ export interface Routes {
|
|
|
13802
15167
|
status: 'pending';
|
|
13803
15168
|
result: null;
|
|
13804
15169
|
error: null;
|
|
13805
|
-
action_type: '
|
|
15170
|
+
action_type: 'SCAN_CARD';
|
|
13806
15171
|
} | {
|
|
13807
15172
|
/** The ID of the action attempt. */
|
|
13808
15173
|
action_attempt_id: string;
|
|
13809
15174
|
status: 'success';
|
|
13810
15175
|
error: null;
|
|
13811
|
-
action_type: '
|
|
15176
|
+
action_type: 'SCAN_CARD';
|
|
13812
15177
|
result: {
|
|
13813
|
-
/**
|
|
13814
|
-
|
|
15178
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
15179
|
+
acs_credential_on_encoder: {
|
|
15180
|
+
/** Date and time the credential was created. */
|
|
15181
|
+
created_at: string;
|
|
15182
|
+
is_issued: boolean | null;
|
|
15183
|
+
/** Date and time the credential will become useable. */
|
|
15184
|
+
starts_at: string | null;
|
|
15185
|
+
/** Date and time the credential will stop being useable. */
|
|
15186
|
+
ends_at: string | null;
|
|
15187
|
+
/** A number or string that physically identifies this card. */
|
|
15188
|
+
card_number: string | null;
|
|
15189
|
+
visionline_metadata?: {
|
|
15190
|
+
card_id: string;
|
|
15191
|
+
card_function_type: 'guest' | 'staff';
|
|
15192
|
+
cancelled: boolean;
|
|
15193
|
+
discarded: boolean;
|
|
15194
|
+
expired: boolean;
|
|
15195
|
+
overwritten: boolean;
|
|
15196
|
+
overridden?: boolean | undefined;
|
|
15197
|
+
pending_auto_update: boolean;
|
|
15198
|
+
card_format: 'TLCode' | 'rfid48';
|
|
15199
|
+
card_holder?: string | undefined;
|
|
15200
|
+
number_of_issued_cards: number;
|
|
15201
|
+
} | undefined;
|
|
15202
|
+
};
|
|
15203
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
15204
|
+
acs_credential_on_seam: ({
|
|
15205
|
+
acs_credential_id: string;
|
|
15206
|
+
acs_user_id?: string | undefined;
|
|
15207
|
+
acs_credential_pool_id?: string | undefined;
|
|
15208
|
+
acs_system_id: string;
|
|
15209
|
+
parent_acs_credential_id?: string | undefined;
|
|
15210
|
+
display_name: string;
|
|
15211
|
+
code?: (string | undefined) | null;
|
|
15212
|
+
card_number?: (string | undefined) | null;
|
|
15213
|
+
is_issued?: boolean | undefined;
|
|
15214
|
+
issued_at?: (string | undefined) | null;
|
|
15215
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
15216
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
15217
|
+
external_type_display_name?: string | undefined;
|
|
15218
|
+
created_at: string;
|
|
15219
|
+
workspace_id: string;
|
|
15220
|
+
starts_at?: string | undefined;
|
|
15221
|
+
ends_at?: string | undefined;
|
|
15222
|
+
errors: Array<{
|
|
15223
|
+
error_code: string;
|
|
15224
|
+
message: string;
|
|
15225
|
+
}>;
|
|
15226
|
+
warnings: Array<{
|
|
15227
|
+
warning_code: string;
|
|
15228
|
+
message: string;
|
|
15229
|
+
}>;
|
|
15230
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
15231
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
15232
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
15233
|
+
visionline_metadata?: {
|
|
15234
|
+
card_function_type: 'guest' | 'staff';
|
|
15235
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
15236
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
15237
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
15238
|
+
is_valid?: boolean | undefined;
|
|
15239
|
+
auto_join?: boolean | undefined;
|
|
15240
|
+
card_id?: string | undefined;
|
|
15241
|
+
credential_id?: string | undefined;
|
|
15242
|
+
} | undefined;
|
|
15243
|
+
is_managed: true;
|
|
15244
|
+
} | {
|
|
15245
|
+
acs_credential_id: string;
|
|
15246
|
+
acs_user_id?: string | undefined;
|
|
15247
|
+
acs_credential_pool_id?: string | undefined;
|
|
15248
|
+
acs_system_id: string;
|
|
15249
|
+
parent_acs_credential_id?: string | undefined;
|
|
15250
|
+
display_name: string;
|
|
15251
|
+
code?: (string | undefined) | null;
|
|
15252
|
+
card_number?: (string | undefined) | null;
|
|
15253
|
+
is_issued?: boolean | undefined;
|
|
15254
|
+
issued_at?: (string | undefined) | null;
|
|
15255
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
15256
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
15257
|
+
external_type_display_name?: string | undefined;
|
|
15258
|
+
created_at: string;
|
|
15259
|
+
workspace_id: string;
|
|
15260
|
+
starts_at?: string | undefined;
|
|
15261
|
+
ends_at?: string | undefined;
|
|
15262
|
+
errors: Array<{
|
|
15263
|
+
error_code: string;
|
|
15264
|
+
message: string;
|
|
15265
|
+
}>;
|
|
15266
|
+
warnings: Array<{
|
|
15267
|
+
warning_code: string;
|
|
15268
|
+
message: string;
|
|
15269
|
+
}>;
|
|
15270
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
15271
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
15272
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
15273
|
+
visionline_metadata?: {
|
|
15274
|
+
card_function_type: 'guest' | 'staff';
|
|
15275
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
15276
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
15277
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
15278
|
+
is_valid?: boolean | undefined;
|
|
15279
|
+
auto_join?: boolean | undefined;
|
|
15280
|
+
card_id?: string | undefined;
|
|
15281
|
+
credential_id?: string | undefined;
|
|
15282
|
+
} | undefined;
|
|
15283
|
+
is_managed: false;
|
|
15284
|
+
}) | null;
|
|
13815
15285
|
};
|
|
13816
15286
|
} | {
|
|
13817
15287
|
/** The ID of the action attempt. */
|
|
13818
15288
|
action_attempt_id: string;
|
|
13819
15289
|
status: 'error';
|
|
13820
15290
|
result: null;
|
|
13821
|
-
action_type: '
|
|
15291
|
+
action_type: 'SCAN_CARD';
|
|
13822
15292
|
error: {
|
|
13823
15293
|
type: 'no_card_on_encoder';
|
|
13824
15294
|
message: string;
|
|
@@ -14258,23 +15728,128 @@ export interface Routes {
|
|
|
14258
15728
|
status: 'pending';
|
|
14259
15729
|
result: null;
|
|
14260
15730
|
error: null;
|
|
14261
|
-
action_type: '
|
|
15731
|
+
action_type: 'SCAN_CARD';
|
|
14262
15732
|
} | {
|
|
14263
15733
|
/** The ID of the action attempt. */
|
|
14264
15734
|
action_attempt_id: string;
|
|
14265
15735
|
status: 'success';
|
|
14266
15736
|
error: null;
|
|
14267
|
-
action_type: '
|
|
15737
|
+
action_type: 'SCAN_CARD';
|
|
14268
15738
|
result: {
|
|
14269
|
-
/**
|
|
14270
|
-
|
|
15739
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
15740
|
+
acs_credential_on_encoder: {
|
|
15741
|
+
/** Date and time the credential was created. */
|
|
15742
|
+
created_at: string;
|
|
15743
|
+
is_issued: boolean | null;
|
|
15744
|
+
/** Date and time the credential will become useable. */
|
|
15745
|
+
starts_at: string | null;
|
|
15746
|
+
/** Date and time the credential will stop being useable. */
|
|
15747
|
+
ends_at: string | null;
|
|
15748
|
+
/** A number or string that physically identifies this card. */
|
|
15749
|
+
card_number: string | null;
|
|
15750
|
+
visionline_metadata?: {
|
|
15751
|
+
card_id: string;
|
|
15752
|
+
card_function_type: 'guest' | 'staff';
|
|
15753
|
+
cancelled: boolean;
|
|
15754
|
+
discarded: boolean;
|
|
15755
|
+
expired: boolean;
|
|
15756
|
+
overwritten: boolean;
|
|
15757
|
+
overridden?: boolean | undefined;
|
|
15758
|
+
pending_auto_update: boolean;
|
|
15759
|
+
card_format: 'TLCode' | 'rfid48';
|
|
15760
|
+
card_holder?: string | undefined;
|
|
15761
|
+
number_of_issued_cards: number;
|
|
15762
|
+
} | undefined;
|
|
15763
|
+
};
|
|
15764
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
15765
|
+
acs_credential_on_seam: ({
|
|
15766
|
+
acs_credential_id: string;
|
|
15767
|
+
acs_user_id?: string | undefined;
|
|
15768
|
+
acs_credential_pool_id?: string | undefined;
|
|
15769
|
+
acs_system_id: string;
|
|
15770
|
+
parent_acs_credential_id?: string | undefined;
|
|
15771
|
+
display_name: string;
|
|
15772
|
+
code?: (string | undefined) | null;
|
|
15773
|
+
card_number?: (string | undefined) | null;
|
|
15774
|
+
is_issued?: boolean | undefined;
|
|
15775
|
+
issued_at?: (string | undefined) | null;
|
|
15776
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
15777
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
15778
|
+
external_type_display_name?: string | undefined;
|
|
15779
|
+
created_at: string;
|
|
15780
|
+
workspace_id: string;
|
|
15781
|
+
starts_at?: string | undefined;
|
|
15782
|
+
ends_at?: string | undefined;
|
|
15783
|
+
errors: Array<{
|
|
15784
|
+
error_code: string;
|
|
15785
|
+
message: string;
|
|
15786
|
+
}>;
|
|
15787
|
+
warnings: Array<{
|
|
15788
|
+
warning_code: string;
|
|
15789
|
+
message: string;
|
|
15790
|
+
}>;
|
|
15791
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
15792
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
15793
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
15794
|
+
visionline_metadata?: {
|
|
15795
|
+
card_function_type: 'guest' | 'staff';
|
|
15796
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
15797
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
15798
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
15799
|
+
is_valid?: boolean | undefined;
|
|
15800
|
+
auto_join?: boolean | undefined;
|
|
15801
|
+
card_id?: string | undefined;
|
|
15802
|
+
credential_id?: string | undefined;
|
|
15803
|
+
} | undefined;
|
|
15804
|
+
is_managed: true;
|
|
15805
|
+
} | {
|
|
15806
|
+
acs_credential_id: string;
|
|
15807
|
+
acs_user_id?: string | undefined;
|
|
15808
|
+
acs_credential_pool_id?: string | undefined;
|
|
15809
|
+
acs_system_id: string;
|
|
15810
|
+
parent_acs_credential_id?: string | undefined;
|
|
15811
|
+
display_name: string;
|
|
15812
|
+
code?: (string | undefined) | null;
|
|
15813
|
+
card_number?: (string | undefined) | null;
|
|
15814
|
+
is_issued?: boolean | undefined;
|
|
15815
|
+
issued_at?: (string | undefined) | null;
|
|
15816
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
15817
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
15818
|
+
external_type_display_name?: string | undefined;
|
|
15819
|
+
created_at: string;
|
|
15820
|
+
workspace_id: string;
|
|
15821
|
+
starts_at?: string | undefined;
|
|
15822
|
+
ends_at?: string | undefined;
|
|
15823
|
+
errors: Array<{
|
|
15824
|
+
error_code: string;
|
|
15825
|
+
message: string;
|
|
15826
|
+
}>;
|
|
15827
|
+
warnings: Array<{
|
|
15828
|
+
warning_code: string;
|
|
15829
|
+
message: string;
|
|
15830
|
+
}>;
|
|
15831
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
15832
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
15833
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
15834
|
+
visionline_metadata?: {
|
|
15835
|
+
card_function_type: 'guest' | 'staff';
|
|
15836
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
15837
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
15838
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
15839
|
+
is_valid?: boolean | undefined;
|
|
15840
|
+
auto_join?: boolean | undefined;
|
|
15841
|
+
card_id?: string | undefined;
|
|
15842
|
+
credential_id?: string | undefined;
|
|
15843
|
+
} | undefined;
|
|
15844
|
+
is_managed: false;
|
|
15845
|
+
}) | null;
|
|
14271
15846
|
};
|
|
14272
15847
|
} | {
|
|
14273
15848
|
/** The ID of the action attempt. */
|
|
14274
15849
|
action_attempt_id: string;
|
|
14275
15850
|
status: 'error';
|
|
14276
15851
|
result: null;
|
|
14277
|
-
action_type: '
|
|
15852
|
+
action_type: 'SCAN_CARD';
|
|
14278
15853
|
error: {
|
|
14279
15854
|
type: 'no_card_on_encoder';
|
|
14280
15855
|
message: string;
|
|
@@ -15198,23 +16773,128 @@ export interface Routes {
|
|
|
15198
16773
|
status: 'pending';
|
|
15199
16774
|
result: null;
|
|
15200
16775
|
error: null;
|
|
15201
|
-
action_type: '
|
|
16776
|
+
action_type: 'SCAN_CARD';
|
|
15202
16777
|
} | {
|
|
15203
16778
|
/** The ID of the action attempt. */
|
|
15204
16779
|
action_attempt_id: string;
|
|
15205
16780
|
status: 'success';
|
|
15206
16781
|
error: null;
|
|
15207
|
-
action_type: '
|
|
16782
|
+
action_type: 'SCAN_CARD';
|
|
15208
16783
|
result: {
|
|
15209
|
-
/**
|
|
15210
|
-
|
|
16784
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
16785
|
+
acs_credential_on_encoder: {
|
|
16786
|
+
/** Date and time the credential was created. */
|
|
16787
|
+
created_at: string;
|
|
16788
|
+
is_issued: boolean | null;
|
|
16789
|
+
/** Date and time the credential will become useable. */
|
|
16790
|
+
starts_at: string | null;
|
|
16791
|
+
/** Date and time the credential will stop being useable. */
|
|
16792
|
+
ends_at: string | null;
|
|
16793
|
+
/** A number or string that physically identifies this card. */
|
|
16794
|
+
card_number: string | null;
|
|
16795
|
+
visionline_metadata?: {
|
|
16796
|
+
card_id: string;
|
|
16797
|
+
card_function_type: 'guest' | 'staff';
|
|
16798
|
+
cancelled: boolean;
|
|
16799
|
+
discarded: boolean;
|
|
16800
|
+
expired: boolean;
|
|
16801
|
+
overwritten: boolean;
|
|
16802
|
+
overridden?: boolean | undefined;
|
|
16803
|
+
pending_auto_update: boolean;
|
|
16804
|
+
card_format: 'TLCode' | 'rfid48';
|
|
16805
|
+
card_holder?: string | undefined;
|
|
16806
|
+
number_of_issued_cards: number;
|
|
16807
|
+
} | undefined;
|
|
16808
|
+
};
|
|
16809
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
16810
|
+
acs_credential_on_seam: ({
|
|
16811
|
+
acs_credential_id: string;
|
|
16812
|
+
acs_user_id?: string | undefined;
|
|
16813
|
+
acs_credential_pool_id?: string | undefined;
|
|
16814
|
+
acs_system_id: string;
|
|
16815
|
+
parent_acs_credential_id?: string | undefined;
|
|
16816
|
+
display_name: string;
|
|
16817
|
+
code?: (string | undefined) | null;
|
|
16818
|
+
card_number?: (string | undefined) | null;
|
|
16819
|
+
is_issued?: boolean | undefined;
|
|
16820
|
+
issued_at?: (string | undefined) | null;
|
|
16821
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
16822
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
16823
|
+
external_type_display_name?: string | undefined;
|
|
16824
|
+
created_at: string;
|
|
16825
|
+
workspace_id: string;
|
|
16826
|
+
starts_at?: string | undefined;
|
|
16827
|
+
ends_at?: string | undefined;
|
|
16828
|
+
errors: Array<{
|
|
16829
|
+
error_code: string;
|
|
16830
|
+
message: string;
|
|
16831
|
+
}>;
|
|
16832
|
+
warnings: Array<{
|
|
16833
|
+
warning_code: string;
|
|
16834
|
+
message: string;
|
|
16835
|
+
}>;
|
|
16836
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
16837
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
16838
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
16839
|
+
visionline_metadata?: {
|
|
16840
|
+
card_function_type: 'guest' | 'staff';
|
|
16841
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
16842
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
16843
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
16844
|
+
is_valid?: boolean | undefined;
|
|
16845
|
+
auto_join?: boolean | undefined;
|
|
16846
|
+
card_id?: string | undefined;
|
|
16847
|
+
credential_id?: string | undefined;
|
|
16848
|
+
} | undefined;
|
|
16849
|
+
is_managed: true;
|
|
16850
|
+
} | {
|
|
16851
|
+
acs_credential_id: string;
|
|
16852
|
+
acs_user_id?: string | undefined;
|
|
16853
|
+
acs_credential_pool_id?: string | undefined;
|
|
16854
|
+
acs_system_id: string;
|
|
16855
|
+
parent_acs_credential_id?: string | undefined;
|
|
16856
|
+
display_name: string;
|
|
16857
|
+
code?: (string | undefined) | null;
|
|
16858
|
+
card_number?: (string | undefined) | null;
|
|
16859
|
+
is_issued?: boolean | undefined;
|
|
16860
|
+
issued_at?: (string | undefined) | null;
|
|
16861
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
16862
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
16863
|
+
external_type_display_name?: string | undefined;
|
|
16864
|
+
created_at: string;
|
|
16865
|
+
workspace_id: string;
|
|
16866
|
+
starts_at?: string | undefined;
|
|
16867
|
+
ends_at?: string | undefined;
|
|
16868
|
+
errors: Array<{
|
|
16869
|
+
error_code: string;
|
|
16870
|
+
message: string;
|
|
16871
|
+
}>;
|
|
16872
|
+
warnings: Array<{
|
|
16873
|
+
warning_code: string;
|
|
16874
|
+
message: string;
|
|
16875
|
+
}>;
|
|
16876
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
16877
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
16878
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
16879
|
+
visionline_metadata?: {
|
|
16880
|
+
card_function_type: 'guest' | 'staff';
|
|
16881
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
16882
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
16883
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
16884
|
+
is_valid?: boolean | undefined;
|
|
16885
|
+
auto_join?: boolean | undefined;
|
|
16886
|
+
card_id?: string | undefined;
|
|
16887
|
+
credential_id?: string | undefined;
|
|
16888
|
+
} | undefined;
|
|
16889
|
+
is_managed: false;
|
|
16890
|
+
}) | null;
|
|
15211
16891
|
};
|
|
15212
16892
|
} | {
|
|
15213
16893
|
/** The ID of the action attempt. */
|
|
15214
16894
|
action_attempt_id: string;
|
|
15215
16895
|
status: 'error';
|
|
15216
16896
|
result: null;
|
|
15217
|
-
action_type: '
|
|
16897
|
+
action_type: 'SCAN_CARD';
|
|
15218
16898
|
error: {
|
|
15219
16899
|
type: 'no_card_on_encoder';
|
|
15220
16900
|
message: string;
|
|
@@ -15656,23 +17336,128 @@ export interface Routes {
|
|
|
15656
17336
|
status: 'pending';
|
|
15657
17337
|
result: null;
|
|
15658
17338
|
error: null;
|
|
15659
|
-
action_type: '
|
|
17339
|
+
action_type: 'SCAN_CARD';
|
|
15660
17340
|
} | {
|
|
15661
17341
|
/** The ID of the action attempt. */
|
|
15662
17342
|
action_attempt_id: string;
|
|
15663
17343
|
status: 'success';
|
|
15664
17344
|
error: null;
|
|
15665
|
-
action_type: '
|
|
17345
|
+
action_type: 'SCAN_CARD';
|
|
15666
17346
|
result: {
|
|
15667
|
-
/**
|
|
15668
|
-
|
|
17347
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
17348
|
+
acs_credential_on_encoder: {
|
|
17349
|
+
/** Date and time the credential was created. */
|
|
17350
|
+
created_at: string;
|
|
17351
|
+
is_issued: boolean | null;
|
|
17352
|
+
/** Date and time the credential will become useable. */
|
|
17353
|
+
starts_at: string | null;
|
|
17354
|
+
/** Date and time the credential will stop being useable. */
|
|
17355
|
+
ends_at: string | null;
|
|
17356
|
+
/** A number or string that physically identifies this card. */
|
|
17357
|
+
card_number: string | null;
|
|
17358
|
+
visionline_metadata?: {
|
|
17359
|
+
card_id: string;
|
|
17360
|
+
card_function_type: 'guest' | 'staff';
|
|
17361
|
+
cancelled: boolean;
|
|
17362
|
+
discarded: boolean;
|
|
17363
|
+
expired: boolean;
|
|
17364
|
+
overwritten: boolean;
|
|
17365
|
+
overridden?: boolean | undefined;
|
|
17366
|
+
pending_auto_update: boolean;
|
|
17367
|
+
card_format: 'TLCode' | 'rfid48';
|
|
17368
|
+
card_holder?: string | undefined;
|
|
17369
|
+
number_of_issued_cards: number;
|
|
17370
|
+
} | undefined;
|
|
17371
|
+
};
|
|
17372
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
17373
|
+
acs_credential_on_seam: ({
|
|
17374
|
+
acs_credential_id: string;
|
|
17375
|
+
acs_user_id?: string | undefined;
|
|
17376
|
+
acs_credential_pool_id?: string | undefined;
|
|
17377
|
+
acs_system_id: string;
|
|
17378
|
+
parent_acs_credential_id?: string | undefined;
|
|
17379
|
+
display_name: string;
|
|
17380
|
+
code?: (string | undefined) | null;
|
|
17381
|
+
card_number?: (string | undefined) | null;
|
|
17382
|
+
is_issued?: boolean | undefined;
|
|
17383
|
+
issued_at?: (string | undefined) | null;
|
|
17384
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
17385
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
17386
|
+
external_type_display_name?: string | undefined;
|
|
17387
|
+
created_at: string;
|
|
17388
|
+
workspace_id: string;
|
|
17389
|
+
starts_at?: string | undefined;
|
|
17390
|
+
ends_at?: string | undefined;
|
|
17391
|
+
errors: Array<{
|
|
17392
|
+
error_code: string;
|
|
17393
|
+
message: string;
|
|
17394
|
+
}>;
|
|
17395
|
+
warnings: Array<{
|
|
17396
|
+
warning_code: string;
|
|
17397
|
+
message: string;
|
|
17398
|
+
}>;
|
|
17399
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
17400
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
17401
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
17402
|
+
visionline_metadata?: {
|
|
17403
|
+
card_function_type: 'guest' | 'staff';
|
|
17404
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
17405
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
17406
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
17407
|
+
is_valid?: boolean | undefined;
|
|
17408
|
+
auto_join?: boolean | undefined;
|
|
17409
|
+
card_id?: string | undefined;
|
|
17410
|
+
credential_id?: string | undefined;
|
|
17411
|
+
} | undefined;
|
|
17412
|
+
is_managed: true;
|
|
17413
|
+
} | {
|
|
17414
|
+
acs_credential_id: string;
|
|
17415
|
+
acs_user_id?: string | undefined;
|
|
17416
|
+
acs_credential_pool_id?: string | undefined;
|
|
17417
|
+
acs_system_id: string;
|
|
17418
|
+
parent_acs_credential_id?: string | undefined;
|
|
17419
|
+
display_name: string;
|
|
17420
|
+
code?: (string | undefined) | null;
|
|
17421
|
+
card_number?: (string | undefined) | null;
|
|
17422
|
+
is_issued?: boolean | undefined;
|
|
17423
|
+
issued_at?: (string | undefined) | null;
|
|
17424
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
17425
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
17426
|
+
external_type_display_name?: string | undefined;
|
|
17427
|
+
created_at: string;
|
|
17428
|
+
workspace_id: string;
|
|
17429
|
+
starts_at?: string | undefined;
|
|
17430
|
+
ends_at?: string | undefined;
|
|
17431
|
+
errors: Array<{
|
|
17432
|
+
error_code: string;
|
|
17433
|
+
message: string;
|
|
17434
|
+
}>;
|
|
17435
|
+
warnings: Array<{
|
|
17436
|
+
warning_code: string;
|
|
17437
|
+
message: string;
|
|
17438
|
+
}>;
|
|
17439
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
17440
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
17441
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
17442
|
+
visionline_metadata?: {
|
|
17443
|
+
card_function_type: 'guest' | 'staff';
|
|
17444
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
17445
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
17446
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
17447
|
+
is_valid?: boolean | undefined;
|
|
17448
|
+
auto_join?: boolean | undefined;
|
|
17449
|
+
card_id?: string | undefined;
|
|
17450
|
+
credential_id?: string | undefined;
|
|
17451
|
+
} | undefined;
|
|
17452
|
+
is_managed: false;
|
|
17453
|
+
}) | null;
|
|
15669
17454
|
};
|
|
15670
17455
|
} | {
|
|
15671
17456
|
/** The ID of the action attempt. */
|
|
15672
17457
|
action_attempt_id: string;
|
|
15673
17458
|
status: 'error';
|
|
15674
17459
|
result: null;
|
|
15675
|
-
action_type: '
|
|
17460
|
+
action_type: 'SCAN_CARD';
|
|
15676
17461
|
error: {
|
|
15677
17462
|
type: 'no_card_on_encoder';
|
|
15678
17463
|
message: string;
|
|
@@ -15993,82 +17778,521 @@ export interface Routes {
|
|
|
15993
17778
|
error: {
|
|
15994
17779
|
type: string;
|
|
15995
17780
|
message: string;
|
|
15996
|
-
};
|
|
15997
|
-
} | {
|
|
15998
|
-
/** The ID of the action attempt. */
|
|
15999
|
-
action_attempt_id: string;
|
|
16000
|
-
status: 'pending';
|
|
16001
|
-
result: null;
|
|
16002
|
-
error: null;
|
|
16003
|
-
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
16004
|
-
} | {
|
|
16005
|
-
/** The ID of the action attempt. */
|
|
16006
|
-
action_attempt_id: string;
|
|
16007
|
-
status: 'success';
|
|
16008
|
-
error: null;
|
|
16009
|
-
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
16010
|
-
result?: any;
|
|
16011
|
-
} | {
|
|
16012
|
-
/** The ID of the action attempt. */
|
|
16013
|
-
action_attempt_id: string;
|
|
16014
|
-
status: 'error';
|
|
16015
|
-
result: null;
|
|
16016
|
-
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
16017
|
-
error: {
|
|
16018
|
-
type: string;
|
|
17781
|
+
};
|
|
17782
|
+
} | {
|
|
17783
|
+
/** The ID of the action attempt. */
|
|
17784
|
+
action_attempt_id: string;
|
|
17785
|
+
status: 'pending';
|
|
17786
|
+
result: null;
|
|
17787
|
+
error: null;
|
|
17788
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
17789
|
+
} | {
|
|
17790
|
+
/** The ID of the action attempt. */
|
|
17791
|
+
action_attempt_id: string;
|
|
17792
|
+
status: 'success';
|
|
17793
|
+
error: null;
|
|
17794
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
17795
|
+
result?: any;
|
|
17796
|
+
} | {
|
|
17797
|
+
/** The ID of the action attempt. */
|
|
17798
|
+
action_attempt_id: string;
|
|
17799
|
+
status: 'error';
|
|
17800
|
+
result: null;
|
|
17801
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
17802
|
+
error: {
|
|
17803
|
+
type: string;
|
|
17804
|
+
message: string;
|
|
17805
|
+
};
|
|
17806
|
+
} | {
|
|
17807
|
+
/** The ID of the action attempt. */
|
|
17808
|
+
action_attempt_id: string;
|
|
17809
|
+
status: 'pending';
|
|
17810
|
+
result: null;
|
|
17811
|
+
error: null;
|
|
17812
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
17813
|
+
} | {
|
|
17814
|
+
/** The ID of the action attempt. */
|
|
17815
|
+
action_attempt_id: string;
|
|
17816
|
+
status: 'success';
|
|
17817
|
+
error: null;
|
|
17818
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
17819
|
+
result?: any;
|
|
17820
|
+
} | {
|
|
17821
|
+
/** The ID of the action attempt. */
|
|
17822
|
+
action_attempt_id: string;
|
|
17823
|
+
status: 'error';
|
|
17824
|
+
result: null;
|
|
17825
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
17826
|
+
error: {
|
|
17827
|
+
type: string;
|
|
17828
|
+
message: string;
|
|
17829
|
+
};
|
|
17830
|
+
};
|
|
17831
|
+
};
|
|
17832
|
+
};
|
|
17833
|
+
'/thermostats/list': {
|
|
17834
|
+
route: '/thermostats/list';
|
|
17835
|
+
method: 'GET' | 'POST';
|
|
17836
|
+
queryParams: {};
|
|
17837
|
+
jsonBody: {};
|
|
17838
|
+
commonParams: {
|
|
17839
|
+
/** List all devices owned by this connected account */
|
|
17840
|
+
connected_account_id?: string | undefined;
|
|
17841
|
+
connected_account_ids?: string[] | undefined;
|
|
17842
|
+
connect_webview_id?: string | undefined;
|
|
17843
|
+
device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | 'visionline_encoder') | undefined;
|
|
17844
|
+
device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | 'visionline_encoder'> | undefined;
|
|
17845
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
|
|
17846
|
+
device_ids?: string[] | undefined;
|
|
17847
|
+
limit?: number;
|
|
17848
|
+
created_before?: Date | undefined;
|
|
17849
|
+
user_identifier_key?: string | undefined;
|
|
17850
|
+
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
17851
|
+
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
17852
|
+
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
17853
|
+
};
|
|
17854
|
+
formData: {};
|
|
17855
|
+
jsonResponse: {
|
|
17856
|
+
thermostats: Array<{
|
|
17857
|
+
/** Unique identifier for the device. */
|
|
17858
|
+
device_id: string;
|
|
17859
|
+
/** Type of the device. */
|
|
17860
|
+
device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | 'visionline_encoder';
|
|
17861
|
+
/** Optional nickname to describe the device, settable through Seam */
|
|
17862
|
+
nickname?: string | undefined;
|
|
17863
|
+
/** 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. */
|
|
17864
|
+
display_name: string;
|
|
17865
|
+
/** 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. */
|
|
17866
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
17867
|
+
/** Properties of the device. */
|
|
17868
|
+
properties: (({
|
|
17869
|
+
/** Indicates whether the device is online. */
|
|
17870
|
+
online: boolean;
|
|
17871
|
+
/** Name of the device.
|
|
17872
|
+
* @deprecated use device.display_name instead */
|
|
17873
|
+
name: string;
|
|
17874
|
+
/** Represents the accessory keypad state. */
|
|
17875
|
+
accessory_keypad?: {
|
|
17876
|
+
/** Indicates if the accessory_keypad is connected to the device. */
|
|
17877
|
+
is_connected: boolean;
|
|
17878
|
+
/** Indicates if the keypad battery properties. */
|
|
17879
|
+
battery?: {
|
|
17880
|
+
level: number;
|
|
17881
|
+
} | undefined;
|
|
17882
|
+
} | undefined;
|
|
17883
|
+
appearance: {
|
|
17884
|
+
/** Name of the device as seen from the provider API and application, not settable through Seam. */
|
|
17885
|
+
name: string;
|
|
17886
|
+
};
|
|
17887
|
+
model: {
|
|
17888
|
+
/** Indicates whether the device can connect a accessory keypad. */
|
|
17889
|
+
can_connect_accessory_keypad?: boolean | undefined;
|
|
17890
|
+
/** Display name of the device model. */
|
|
17891
|
+
display_name: string;
|
|
17892
|
+
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
17893
|
+
manufacturer_display_name: string;
|
|
17894
|
+
/** Indicates whether the device has a built in accessory keypad. */
|
|
17895
|
+
has_built_in_keypad?: boolean | undefined;
|
|
17896
|
+
/** Indicates whether the device supports offline access codes. */
|
|
17897
|
+
offline_access_codes_supported?: boolean | undefined;
|
|
17898
|
+
/** Indicates whether the device supports online access codes. */
|
|
17899
|
+
online_access_codes_supported?: boolean | undefined;
|
|
17900
|
+
/**
|
|
17901
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
17902
|
+
accessory_keypad_supported?: boolean | undefined;
|
|
17903
|
+
};
|
|
17904
|
+
/** Indicates whether the device has direct power. */
|
|
17905
|
+
has_direct_power?: boolean | undefined;
|
|
17906
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
17907
|
+
battery_level?: number | undefined;
|
|
17908
|
+
/** 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. */
|
|
17909
|
+
battery?: {
|
|
17910
|
+
level: number;
|
|
17911
|
+
status: 'critical' | 'low' | 'good' | 'full';
|
|
17912
|
+
} | undefined;
|
|
17913
|
+
/** Manufacturer of the device. */
|
|
17914
|
+
manufacturer?: string | undefined;
|
|
17915
|
+
/** Image URL for the device. */
|
|
17916
|
+
image_url?: string | undefined;
|
|
17917
|
+
/** Alt text for the device image. */
|
|
17918
|
+
image_alt_text?: string | undefined;
|
|
17919
|
+
/** Serial number of the device. */
|
|
17920
|
+
serial_number?: string | undefined;
|
|
17921
|
+
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
17922
|
+
online_access_codes_enabled?: boolean | undefined;
|
|
17923
|
+
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
17924
|
+
offline_access_codes_enabled?: boolean | undefined;
|
|
17925
|
+
/**
|
|
17926
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
17927
|
+
supports_accessory_keypad?: boolean | undefined;
|
|
17928
|
+
/**
|
|
17929
|
+
* @deprecated use offline_access_codes_enabled */
|
|
17930
|
+
supports_offline_access_codes?: boolean | undefined;
|
|
17931
|
+
/** Indicates current noise level in decibels, if the device supports noise detection. */
|
|
17932
|
+
noise_level_decibels?: number | undefined;
|
|
17933
|
+
/** Array of noise threshold IDs that are currently triggering. */
|
|
17934
|
+
currently_triggering_noise_threshold_ids?: string[] | undefined;
|
|
17935
|
+
} & {
|
|
17936
|
+
assa_abloy_credential_service_metadata?: ({
|
|
17937
|
+
has_active_endpoint: boolean;
|
|
17938
|
+
endpoints: Array<{
|
|
17939
|
+
endpoint_id: string;
|
|
17940
|
+
is_active: boolean;
|
|
17941
|
+
}>;
|
|
17942
|
+
} | undefined) | undefined;
|
|
17943
|
+
}) & {
|
|
17944
|
+
august_metadata?: {
|
|
17945
|
+
lock_id: string;
|
|
17946
|
+
lock_name: string;
|
|
17947
|
+
house_name: string;
|
|
17948
|
+
has_keypad: boolean;
|
|
17949
|
+
keypad_battery_level?: string | undefined;
|
|
17950
|
+
model?: string | undefined;
|
|
17951
|
+
house_id?: string | undefined;
|
|
17952
|
+
} | undefined;
|
|
17953
|
+
avigilon_alta_metadata?: {
|
|
17954
|
+
entry_name: string;
|
|
17955
|
+
org_name: string;
|
|
17956
|
+
zone_id: number;
|
|
17957
|
+
zone_name: string;
|
|
17958
|
+
site_id: number;
|
|
17959
|
+
site_name: string;
|
|
17960
|
+
entry_relays_total_count: number;
|
|
17961
|
+
} | undefined;
|
|
17962
|
+
schlage_metadata?: {
|
|
17963
|
+
device_id: string;
|
|
17964
|
+
device_name: string;
|
|
17965
|
+
access_code_length: number | null;
|
|
17966
|
+
model?: string | undefined;
|
|
17967
|
+
} | undefined;
|
|
17968
|
+
smartthings_metadata?: {
|
|
17969
|
+
device_id: string;
|
|
17970
|
+
device_name: string;
|
|
17971
|
+
model?: string | undefined;
|
|
17972
|
+
location_id?: string | undefined;
|
|
17973
|
+
} | undefined;
|
|
17974
|
+
lockly_metadata?: {
|
|
17975
|
+
device_id: string;
|
|
17976
|
+
device_name: string;
|
|
17977
|
+
model?: string | undefined;
|
|
17978
|
+
} | undefined;
|
|
17979
|
+
nuki_metadata?: {
|
|
17980
|
+
device_id: string;
|
|
17981
|
+
device_name: string;
|
|
17982
|
+
keypad_battery_critical?: boolean | undefined;
|
|
17983
|
+
keypad_paired?: boolean | undefined;
|
|
17984
|
+
keypad_2_paired?: boolean | undefined;
|
|
17985
|
+
} | undefined;
|
|
17986
|
+
kwikset_metadata?: {
|
|
17987
|
+
device_id: string;
|
|
17988
|
+
device_name: string;
|
|
17989
|
+
model_number: string;
|
|
17990
|
+
} | undefined;
|
|
17991
|
+
salto_metadata?: {
|
|
17992
|
+
lock_id: string;
|
|
17993
|
+
customer_reference: string;
|
|
17994
|
+
lock_type: string;
|
|
17995
|
+
battery_level: string;
|
|
17996
|
+
locked_state: string;
|
|
17997
|
+
model?: string | undefined;
|
|
17998
|
+
} | undefined;
|
|
17999
|
+
genie_metadata?: {
|
|
18000
|
+
device_name: string;
|
|
18001
|
+
door_name: string;
|
|
18002
|
+
} | undefined;
|
|
18003
|
+
brivo_metadata?: {
|
|
18004
|
+
device_name: string;
|
|
18005
|
+
} | undefined;
|
|
18006
|
+
igloo_metadata?: {
|
|
18007
|
+
device_id: string;
|
|
18008
|
+
bridge_id: string;
|
|
18009
|
+
model?: string | undefined;
|
|
18010
|
+
} | undefined;
|
|
18011
|
+
noiseaware_metadata?: {
|
|
18012
|
+
device_model: 'indoor' | 'outdoor';
|
|
18013
|
+
noise_level_nrs: number;
|
|
18014
|
+
noise_level_decibel: number;
|
|
18015
|
+
device_name: string;
|
|
18016
|
+
device_id: string;
|
|
18017
|
+
} | undefined;
|
|
18018
|
+
minut_metadata?: {
|
|
18019
|
+
device_id: string;
|
|
18020
|
+
device_name: string;
|
|
18021
|
+
latest_sensor_values: {
|
|
18022
|
+
temperature: {
|
|
18023
|
+
time: string;
|
|
18024
|
+
value: number;
|
|
18025
|
+
};
|
|
18026
|
+
sound: {
|
|
18027
|
+
time: string;
|
|
18028
|
+
value: number;
|
|
18029
|
+
};
|
|
18030
|
+
humidity: {
|
|
18031
|
+
time: string;
|
|
18032
|
+
value: number;
|
|
18033
|
+
};
|
|
18034
|
+
pressure: {
|
|
18035
|
+
time: string;
|
|
18036
|
+
value: number;
|
|
18037
|
+
};
|
|
18038
|
+
accelerometer_z: {
|
|
18039
|
+
time: string;
|
|
18040
|
+
value: number;
|
|
18041
|
+
};
|
|
18042
|
+
};
|
|
18043
|
+
} | undefined;
|
|
18044
|
+
four_suites_metadata?: {
|
|
18045
|
+
device_id: number;
|
|
18046
|
+
device_name: string;
|
|
18047
|
+
reclose_delay_in_seconds: number;
|
|
18048
|
+
} | undefined;
|
|
18049
|
+
two_n_metadata?: {
|
|
18050
|
+
device_id: number;
|
|
18051
|
+
device_name: string;
|
|
18052
|
+
} | undefined;
|
|
18053
|
+
controlbyweb_metadata?: {
|
|
18054
|
+
device_id: string;
|
|
18055
|
+
device_name: string;
|
|
18056
|
+
relay_name: string | null;
|
|
18057
|
+
} | undefined;
|
|
18058
|
+
ttlock_metadata?: {
|
|
18059
|
+
lock_id: number;
|
|
18060
|
+
lock_alias: string;
|
|
18061
|
+
feature_value: string;
|
|
18062
|
+
features: {
|
|
18063
|
+
passcode: boolean;
|
|
18064
|
+
passcode_management: boolean;
|
|
18065
|
+
unlock_via_gateway: boolean;
|
|
18066
|
+
lock_command: boolean;
|
|
18067
|
+
incomplete_keyboard_passcode: boolean;
|
|
18068
|
+
};
|
|
18069
|
+
has_gateway?: boolean | undefined;
|
|
18070
|
+
wireless_keypads?: Array<{
|
|
18071
|
+
wireless_keypad_id: number;
|
|
18072
|
+
wireless_keypad_name: string;
|
|
18073
|
+
}> | undefined;
|
|
18074
|
+
} | undefined;
|
|
18075
|
+
seam_bridge_metadata?: {
|
|
18076
|
+
unlock_method?: ('bridge' | 'doorking') | undefined;
|
|
18077
|
+
device_num: number;
|
|
18078
|
+
name: string;
|
|
18079
|
+
} | undefined;
|
|
18080
|
+
igloohome_metadata?: {
|
|
18081
|
+
device_id: string;
|
|
18082
|
+
device_name: string;
|
|
18083
|
+
bridge_id?: string | undefined;
|
|
18084
|
+
bridge_name?: string | undefined;
|
|
18085
|
+
keypad_id?: string | undefined;
|
|
18086
|
+
} | undefined;
|
|
18087
|
+
nest_metadata?: {
|
|
18088
|
+
nest_device_id: string;
|
|
18089
|
+
device_name: string;
|
|
18090
|
+
custom_name: string;
|
|
18091
|
+
} | undefined;
|
|
18092
|
+
ecobee_metadata?: {
|
|
18093
|
+
ecobee_device_id: string;
|
|
18094
|
+
device_name: string;
|
|
18095
|
+
} | undefined;
|
|
18096
|
+
honeywell_resideo_metadata?: {
|
|
18097
|
+
honeywell_resideo_device_id: string;
|
|
18098
|
+
device_name: string;
|
|
18099
|
+
} | undefined;
|
|
18100
|
+
hubitat_metadata?: {
|
|
18101
|
+
device_id: string;
|
|
18102
|
+
device_name: string;
|
|
18103
|
+
device_label: string;
|
|
18104
|
+
} | undefined;
|
|
18105
|
+
dormakaba_oracode_metadata?: {
|
|
18106
|
+
door_id?: number | undefined;
|
|
18107
|
+
door_name: string;
|
|
18108
|
+
device_id?: (number | string) | undefined;
|
|
18109
|
+
door_is_wireless: boolean;
|
|
18110
|
+
/** @DEPRECATED */
|
|
18111
|
+
site_id: number | null;
|
|
18112
|
+
site_name: string;
|
|
18113
|
+
iana_timezone?: string | undefined;
|
|
18114
|
+
predefined_time_slots?: Array<{
|
|
18115
|
+
name: string;
|
|
18116
|
+
prefix: number;
|
|
18117
|
+
check_in_time: string;
|
|
18118
|
+
check_out_time: string;
|
|
18119
|
+
is_24_hour: boolean;
|
|
18120
|
+
is_biweekly_mode: boolean;
|
|
18121
|
+
is_one_shot: boolean;
|
|
18122
|
+
is_master: boolean;
|
|
18123
|
+
ext_dormakaba_oracode_user_level_prefix: number;
|
|
18124
|
+
dormakaba_oracode_user_level_id: string;
|
|
18125
|
+
}> | undefined;
|
|
18126
|
+
} | undefined;
|
|
18127
|
+
wyze_metadata?: {
|
|
18128
|
+
device_id: string;
|
|
18129
|
+
device_name: string;
|
|
18130
|
+
product_name: string;
|
|
18131
|
+
product_type: string;
|
|
18132
|
+
product_model: string;
|
|
18133
|
+
device_info_model: string;
|
|
18134
|
+
keypad_uuid?: string | undefined;
|
|
18135
|
+
locker_status_hardlock?: number | undefined;
|
|
18136
|
+
} | undefined;
|
|
18137
|
+
tedee_metadata?: {
|
|
18138
|
+
device_id: number;
|
|
18139
|
+
serial_number: string;
|
|
18140
|
+
device_name: string;
|
|
18141
|
+
device_model: string;
|
|
18142
|
+
bridge_id: number;
|
|
18143
|
+
bridge_name: string;
|
|
18144
|
+
keypad_id?: number | undefined;
|
|
18145
|
+
} | undefined;
|
|
18146
|
+
visionline_metadata?: {
|
|
18147
|
+
encoder_id: string;
|
|
18148
|
+
} | undefined;
|
|
18149
|
+
akiles_metadata?: {
|
|
18150
|
+
gadget_name: string;
|
|
18151
|
+
gadget_id: string;
|
|
18152
|
+
} | undefined;
|
|
18153
|
+
}) & ({
|
|
18154
|
+
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
18155
|
+
code_constraints?: (Array<{
|
|
18156
|
+
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
18157
|
+
} | {
|
|
18158
|
+
constraint_type: 'name_length' | 'name_must_be_unique';
|
|
18159
|
+
min_length?: number | undefined;
|
|
18160
|
+
max_length?: number | undefined;
|
|
18161
|
+
}> | undefined) | undefined;
|
|
18162
|
+
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
18163
|
+
max_active_codes_supported?: (number | undefined) | undefined;
|
|
18164
|
+
supports_backup_access_code_pool?: (boolean | undefined) | undefined;
|
|
18165
|
+
has_native_entry_events?: (boolean | undefined) | undefined;
|
|
18166
|
+
locked?: (boolean | undefined) | undefined;
|
|
18167
|
+
keypad_battery?: ({
|
|
18168
|
+
level: number;
|
|
18169
|
+
} | undefined) | undefined;
|
|
18170
|
+
door_open?: (boolean | undefined) | undefined;
|
|
18171
|
+
} & {
|
|
18172
|
+
temperature_fahrenheit?: number | undefined;
|
|
18173
|
+
temperature_celsius?: number | undefined;
|
|
18174
|
+
relative_humidity?: number | undefined;
|
|
18175
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
18176
|
+
available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
|
|
18177
|
+
is_heating?: boolean | undefined;
|
|
18178
|
+
is_cooling?: boolean | undefined;
|
|
18179
|
+
is_fan_running?: boolean | undefined;
|
|
18180
|
+
/**
|
|
18181
|
+
* @deprecated use current_climate_setting.fan_mode_setting instead. */
|
|
18182
|
+
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
18183
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
18184
|
+
current_climate_setting?: {
|
|
18185
|
+
climate_preset_key?: string | undefined;
|
|
18186
|
+
can_edit?: boolean | undefined;
|
|
18187
|
+
can_delete?: boolean | undefined;
|
|
18188
|
+
name?: ((string | null) | undefined) | undefined;
|
|
18189
|
+
display_name?: string | undefined;
|
|
18190
|
+
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
18191
|
+
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
18192
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
18193
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
18194
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
18195
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
18196
|
+
manual_override_allowed?: boolean | undefined;
|
|
18197
|
+
} | undefined;
|
|
18198
|
+
/**
|
|
18199
|
+
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
18200
|
+
default_climate_setting?: {
|
|
18201
|
+
climate_preset_key?: string | undefined;
|
|
18202
|
+
can_edit?: boolean | undefined;
|
|
18203
|
+
can_delete?: boolean | undefined;
|
|
18204
|
+
name?: ((string | null) | undefined) | undefined;
|
|
18205
|
+
display_name?: string | undefined;
|
|
18206
|
+
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
18207
|
+
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
18208
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
18209
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
18210
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
18211
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
18212
|
+
manual_override_allowed?: boolean | undefined;
|
|
18213
|
+
} | undefined;
|
|
18214
|
+
available_climate_presets?: Array<{
|
|
18215
|
+
climate_preset_key: string;
|
|
18216
|
+
can_edit: boolean;
|
|
18217
|
+
can_delete: boolean;
|
|
18218
|
+
name?: (string | null) | undefined;
|
|
18219
|
+
display_name: string;
|
|
18220
|
+
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
18221
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
18222
|
+
cooling_set_point_celsius?: number | undefined;
|
|
18223
|
+
heating_set_point_celsius?: number | undefined;
|
|
18224
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
18225
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
18226
|
+
manual_override_allowed: boolean;
|
|
18227
|
+
}> | undefined;
|
|
18228
|
+
fallback_climate_preset_key?: (string | null) | undefined;
|
|
18229
|
+
active_thermostat_schedule?: ({
|
|
18230
|
+
thermostat_schedule_id: string;
|
|
18231
|
+
device_id: string;
|
|
18232
|
+
name?: string | undefined;
|
|
18233
|
+
climate_preset_key: string;
|
|
18234
|
+
max_override_period_minutes: number;
|
|
18235
|
+
starts_at: string;
|
|
18236
|
+
ends_at: string;
|
|
18237
|
+
created_at: string;
|
|
18238
|
+
/** 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. */
|
|
18239
|
+
errors?: any;
|
|
18240
|
+
} | null) | undefined;
|
|
18241
|
+
min_cooling_set_point_celsius?: number | undefined;
|
|
18242
|
+
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
18243
|
+
max_cooling_set_point_celsius?: number | undefined;
|
|
18244
|
+
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
18245
|
+
min_heating_set_point_celsius?: number | undefined;
|
|
18246
|
+
min_heating_set_point_fahrenheit?: number | undefined;
|
|
18247
|
+
max_heating_set_point_celsius?: number | undefined;
|
|
18248
|
+
max_heating_set_point_fahrenheit?: number | undefined;
|
|
18249
|
+
min_heating_cooling_delta_celsius?: number | undefined;
|
|
18250
|
+
min_heating_cooling_delta_fahrenheit?: number | undefined;
|
|
18251
|
+
});
|
|
18252
|
+
/** Location information for the device. */
|
|
18253
|
+
location: {
|
|
18254
|
+
/** Name of the device location. */
|
|
18255
|
+
location_name?: string | undefined;
|
|
18256
|
+
/** Time zone of the device location. */
|
|
18257
|
+
timezone?: string | undefined;
|
|
18258
|
+
} | null;
|
|
18259
|
+
/** Unique identifier for the account associated with the device. */
|
|
18260
|
+
connected_account_id: string;
|
|
18261
|
+
/** Unique identifier for the Seam workspace associated with the device. */
|
|
18262
|
+
workspace_id: string;
|
|
18263
|
+
/** 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. */
|
|
18264
|
+
errors: Array<{
|
|
18265
|
+
message: string;
|
|
18266
|
+
is_device_error: true;
|
|
18267
|
+
error_code: string;
|
|
18268
|
+
} | {
|
|
16019
18269
|
message: string;
|
|
16020
|
-
|
|
16021
|
-
|
|
16022
|
-
|
|
16023
|
-
|
|
16024
|
-
|
|
16025
|
-
result: null;
|
|
16026
|
-
error: null;
|
|
16027
|
-
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
16028
|
-
} | {
|
|
16029
|
-
/** The ID of the action attempt. */
|
|
16030
|
-
action_attempt_id: string;
|
|
16031
|
-
status: 'success';
|
|
16032
|
-
error: null;
|
|
16033
|
-
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
16034
|
-
result?: any;
|
|
16035
|
-
} | {
|
|
16036
|
-
/** The ID of the action attempt. */
|
|
16037
|
-
action_attempt_id: string;
|
|
16038
|
-
status: 'error';
|
|
16039
|
-
result: null;
|
|
16040
|
-
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
16041
|
-
error: {
|
|
16042
|
-
type: string;
|
|
18270
|
+
is_connected_account_error: true;
|
|
18271
|
+
error_code: string;
|
|
18272
|
+
}>;
|
|
18273
|
+
/** 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. */
|
|
18274
|
+
warnings: Array<{
|
|
16043
18275
|
message: string;
|
|
16044
|
-
|
|
16045
|
-
|
|
16046
|
-
|
|
16047
|
-
|
|
16048
|
-
|
|
16049
|
-
|
|
16050
|
-
|
|
16051
|
-
|
|
16052
|
-
|
|
16053
|
-
|
|
16054
|
-
|
|
16055
|
-
|
|
16056
|
-
|
|
16057
|
-
|
|
16058
|
-
|
|
16059
|
-
|
|
16060
|
-
|
|
16061
|
-
|
|
16062
|
-
|
|
16063
|
-
|
|
16064
|
-
user_identifier_key?: string | undefined;
|
|
16065
|
-
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
16066
|
-
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
16067
|
-
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
16068
|
-
};
|
|
16069
|
-
formData: {};
|
|
16070
|
-
jsonResponse: {
|
|
16071
|
-
thermostats: Array<{
|
|
18276
|
+
warning_code: string;
|
|
18277
|
+
}>;
|
|
18278
|
+
/** Date and time at which the device object was created. */
|
|
18279
|
+
created_at: string;
|
|
18280
|
+
/** Indicates whether Seam manages the device. */
|
|
18281
|
+
is_managed: true;
|
|
18282
|
+
custom_metadata: Record<string, string | boolean>;
|
|
18283
|
+
can_remotely_unlock?: boolean | undefined;
|
|
18284
|
+
can_remotely_lock?: boolean | undefined;
|
|
18285
|
+
can_program_offline_access_codes?: boolean | undefined;
|
|
18286
|
+
can_program_online_access_codes?: boolean | undefined;
|
|
18287
|
+
can_hvac_heat?: boolean | undefined;
|
|
18288
|
+
can_hvac_cool?: boolean | undefined;
|
|
18289
|
+
can_hvac_heat_cool?: boolean | undefined;
|
|
18290
|
+
can_turn_off_hvac?: boolean | undefined;
|
|
18291
|
+
can_simulate_removal?: boolean | undefined;
|
|
18292
|
+
can_simulate_connection?: boolean | undefined;
|
|
18293
|
+
can_simulate_disconnection?: boolean | undefined;
|
|
18294
|
+
}>;
|
|
18295
|
+
devices: Array<{
|
|
16072
18296
|
/** Unique identifier for the device. */
|
|
16073
18297
|
device_id: string;
|
|
16074
18298
|
/** Type of the device. */
|
|
@@ -16574,23 +18798,128 @@ export interface Routes {
|
|
|
16574
18798
|
status: 'pending';
|
|
16575
18799
|
result: null;
|
|
16576
18800
|
error: null;
|
|
16577
|
-
action_type: '
|
|
18801
|
+
action_type: 'SCAN_CARD';
|
|
16578
18802
|
} | {
|
|
16579
18803
|
/** The ID of the action attempt. */
|
|
16580
18804
|
action_attempt_id: string;
|
|
16581
18805
|
status: 'success';
|
|
16582
18806
|
error: null;
|
|
16583
|
-
action_type: '
|
|
18807
|
+
action_type: 'SCAN_CARD';
|
|
16584
18808
|
result: {
|
|
16585
|
-
/**
|
|
16586
|
-
|
|
18809
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
18810
|
+
acs_credential_on_encoder: {
|
|
18811
|
+
/** Date and time the credential was created. */
|
|
18812
|
+
created_at: string;
|
|
18813
|
+
is_issued: boolean | null;
|
|
18814
|
+
/** Date and time the credential will become useable. */
|
|
18815
|
+
starts_at: string | null;
|
|
18816
|
+
/** Date and time the credential will stop being useable. */
|
|
18817
|
+
ends_at: string | null;
|
|
18818
|
+
/** A number or string that physically identifies this card. */
|
|
18819
|
+
card_number: string | null;
|
|
18820
|
+
visionline_metadata?: {
|
|
18821
|
+
card_id: string;
|
|
18822
|
+
card_function_type: 'guest' | 'staff';
|
|
18823
|
+
cancelled: boolean;
|
|
18824
|
+
discarded: boolean;
|
|
18825
|
+
expired: boolean;
|
|
18826
|
+
overwritten: boolean;
|
|
18827
|
+
overridden?: boolean | undefined;
|
|
18828
|
+
pending_auto_update: boolean;
|
|
18829
|
+
card_format: 'TLCode' | 'rfid48';
|
|
18830
|
+
card_holder?: string | undefined;
|
|
18831
|
+
number_of_issued_cards: number;
|
|
18832
|
+
} | undefined;
|
|
18833
|
+
};
|
|
18834
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
18835
|
+
acs_credential_on_seam: ({
|
|
18836
|
+
acs_credential_id: string;
|
|
18837
|
+
acs_user_id?: string | undefined;
|
|
18838
|
+
acs_credential_pool_id?: string | undefined;
|
|
18839
|
+
acs_system_id: string;
|
|
18840
|
+
parent_acs_credential_id?: string | undefined;
|
|
18841
|
+
display_name: string;
|
|
18842
|
+
code?: (string | undefined) | null;
|
|
18843
|
+
card_number?: (string | undefined) | null;
|
|
18844
|
+
is_issued?: boolean | undefined;
|
|
18845
|
+
issued_at?: (string | undefined) | null;
|
|
18846
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
18847
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
18848
|
+
external_type_display_name?: string | undefined;
|
|
18849
|
+
created_at: string;
|
|
18850
|
+
workspace_id: string;
|
|
18851
|
+
starts_at?: string | undefined;
|
|
18852
|
+
ends_at?: string | undefined;
|
|
18853
|
+
errors: Array<{
|
|
18854
|
+
error_code: string;
|
|
18855
|
+
message: string;
|
|
18856
|
+
}>;
|
|
18857
|
+
warnings: Array<{
|
|
18858
|
+
warning_code: string;
|
|
18859
|
+
message: string;
|
|
18860
|
+
}>;
|
|
18861
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
18862
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
18863
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
18864
|
+
visionline_metadata?: {
|
|
18865
|
+
card_function_type: 'guest' | 'staff';
|
|
18866
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
18867
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
18868
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
18869
|
+
is_valid?: boolean | undefined;
|
|
18870
|
+
auto_join?: boolean | undefined;
|
|
18871
|
+
card_id?: string | undefined;
|
|
18872
|
+
credential_id?: string | undefined;
|
|
18873
|
+
} | undefined;
|
|
18874
|
+
is_managed: true;
|
|
18875
|
+
} | {
|
|
18876
|
+
acs_credential_id: string;
|
|
18877
|
+
acs_user_id?: string | undefined;
|
|
18878
|
+
acs_credential_pool_id?: string | undefined;
|
|
18879
|
+
acs_system_id: string;
|
|
18880
|
+
parent_acs_credential_id?: string | undefined;
|
|
18881
|
+
display_name: string;
|
|
18882
|
+
code?: (string | undefined) | null;
|
|
18883
|
+
card_number?: (string | undefined) | null;
|
|
18884
|
+
is_issued?: boolean | undefined;
|
|
18885
|
+
issued_at?: (string | undefined) | null;
|
|
18886
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
18887
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
18888
|
+
external_type_display_name?: string | undefined;
|
|
18889
|
+
created_at: string;
|
|
18890
|
+
workspace_id: string;
|
|
18891
|
+
starts_at?: string | undefined;
|
|
18892
|
+
ends_at?: string | undefined;
|
|
18893
|
+
errors: Array<{
|
|
18894
|
+
error_code: string;
|
|
18895
|
+
message: string;
|
|
18896
|
+
}>;
|
|
18897
|
+
warnings: Array<{
|
|
18898
|
+
warning_code: string;
|
|
18899
|
+
message: string;
|
|
18900
|
+
}>;
|
|
18901
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
18902
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
18903
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
18904
|
+
visionline_metadata?: {
|
|
18905
|
+
card_function_type: 'guest' | 'staff';
|
|
18906
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
18907
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
18908
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
18909
|
+
is_valid?: boolean | undefined;
|
|
18910
|
+
auto_join?: boolean | undefined;
|
|
18911
|
+
card_id?: string | undefined;
|
|
18912
|
+
credential_id?: string | undefined;
|
|
18913
|
+
} | undefined;
|
|
18914
|
+
is_managed: false;
|
|
18915
|
+
}) | null;
|
|
16587
18916
|
};
|
|
16588
18917
|
} | {
|
|
16589
18918
|
/** The ID of the action attempt. */
|
|
16590
18919
|
action_attempt_id: string;
|
|
16591
18920
|
status: 'error';
|
|
16592
18921
|
result: null;
|
|
16593
|
-
action_type: '
|
|
18922
|
+
action_type: 'SCAN_CARD';
|
|
16594
18923
|
error: {
|
|
16595
18924
|
type: 'no_card_on_encoder';
|
|
16596
18925
|
message: string;
|
|
@@ -17149,23 +19478,128 @@ export interface Routes {
|
|
|
17149
19478
|
status: 'pending';
|
|
17150
19479
|
result: null;
|
|
17151
19480
|
error: null;
|
|
17152
|
-
action_type: '
|
|
19481
|
+
action_type: 'SCAN_CARD';
|
|
17153
19482
|
} | {
|
|
17154
19483
|
/** The ID of the action attempt. */
|
|
17155
19484
|
action_attempt_id: string;
|
|
17156
19485
|
status: 'success';
|
|
17157
19486
|
error: null;
|
|
17158
|
-
action_type: '
|
|
19487
|
+
action_type: 'SCAN_CARD';
|
|
17159
19488
|
result: {
|
|
17160
|
-
/**
|
|
17161
|
-
|
|
19489
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
19490
|
+
acs_credential_on_encoder: {
|
|
19491
|
+
/** Date and time the credential was created. */
|
|
19492
|
+
created_at: string;
|
|
19493
|
+
is_issued: boolean | null;
|
|
19494
|
+
/** Date and time the credential will become useable. */
|
|
19495
|
+
starts_at: string | null;
|
|
19496
|
+
/** Date and time the credential will stop being useable. */
|
|
19497
|
+
ends_at: string | null;
|
|
19498
|
+
/** A number or string that physically identifies this card. */
|
|
19499
|
+
card_number: string | null;
|
|
19500
|
+
visionline_metadata?: {
|
|
19501
|
+
card_id: string;
|
|
19502
|
+
card_function_type: 'guest' | 'staff';
|
|
19503
|
+
cancelled: boolean;
|
|
19504
|
+
discarded: boolean;
|
|
19505
|
+
expired: boolean;
|
|
19506
|
+
overwritten: boolean;
|
|
19507
|
+
overridden?: boolean | undefined;
|
|
19508
|
+
pending_auto_update: boolean;
|
|
19509
|
+
card_format: 'TLCode' | 'rfid48';
|
|
19510
|
+
card_holder?: string | undefined;
|
|
19511
|
+
number_of_issued_cards: number;
|
|
19512
|
+
} | undefined;
|
|
19513
|
+
};
|
|
19514
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
19515
|
+
acs_credential_on_seam: ({
|
|
19516
|
+
acs_credential_id: string;
|
|
19517
|
+
acs_user_id?: string | undefined;
|
|
19518
|
+
acs_credential_pool_id?: string | undefined;
|
|
19519
|
+
acs_system_id: string;
|
|
19520
|
+
parent_acs_credential_id?: string | undefined;
|
|
19521
|
+
display_name: string;
|
|
19522
|
+
code?: (string | undefined) | null;
|
|
19523
|
+
card_number?: (string | undefined) | null;
|
|
19524
|
+
is_issued?: boolean | undefined;
|
|
19525
|
+
issued_at?: (string | undefined) | null;
|
|
19526
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
19527
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
19528
|
+
external_type_display_name?: string | undefined;
|
|
19529
|
+
created_at: string;
|
|
19530
|
+
workspace_id: string;
|
|
19531
|
+
starts_at?: string | undefined;
|
|
19532
|
+
ends_at?: string | undefined;
|
|
19533
|
+
errors: Array<{
|
|
19534
|
+
error_code: string;
|
|
19535
|
+
message: string;
|
|
19536
|
+
}>;
|
|
19537
|
+
warnings: Array<{
|
|
19538
|
+
warning_code: string;
|
|
19539
|
+
message: string;
|
|
19540
|
+
}>;
|
|
19541
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
19542
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
19543
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
19544
|
+
visionline_metadata?: {
|
|
19545
|
+
card_function_type: 'guest' | 'staff';
|
|
19546
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
19547
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
19548
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
19549
|
+
is_valid?: boolean | undefined;
|
|
19550
|
+
auto_join?: boolean | undefined;
|
|
19551
|
+
card_id?: string | undefined;
|
|
19552
|
+
credential_id?: string | undefined;
|
|
19553
|
+
} | undefined;
|
|
19554
|
+
is_managed: true;
|
|
19555
|
+
} | {
|
|
19556
|
+
acs_credential_id: string;
|
|
19557
|
+
acs_user_id?: string | undefined;
|
|
19558
|
+
acs_credential_pool_id?: string | undefined;
|
|
19559
|
+
acs_system_id: string;
|
|
19560
|
+
parent_acs_credential_id?: string | undefined;
|
|
19561
|
+
display_name: string;
|
|
19562
|
+
code?: (string | undefined) | null;
|
|
19563
|
+
card_number?: (string | undefined) | null;
|
|
19564
|
+
is_issued?: boolean | undefined;
|
|
19565
|
+
issued_at?: (string | undefined) | null;
|
|
19566
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
19567
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
19568
|
+
external_type_display_name?: string | undefined;
|
|
19569
|
+
created_at: string;
|
|
19570
|
+
workspace_id: string;
|
|
19571
|
+
starts_at?: string | undefined;
|
|
19572
|
+
ends_at?: string | undefined;
|
|
19573
|
+
errors: Array<{
|
|
19574
|
+
error_code: string;
|
|
19575
|
+
message: string;
|
|
19576
|
+
}>;
|
|
19577
|
+
warnings: Array<{
|
|
19578
|
+
warning_code: string;
|
|
19579
|
+
message: string;
|
|
19580
|
+
}>;
|
|
19581
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
19582
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
19583
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
19584
|
+
visionline_metadata?: {
|
|
19585
|
+
card_function_type: 'guest' | 'staff';
|
|
19586
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
19587
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
19588
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
19589
|
+
is_valid?: boolean | undefined;
|
|
19590
|
+
auto_join?: boolean | undefined;
|
|
19591
|
+
card_id?: string | undefined;
|
|
19592
|
+
credential_id?: string | undefined;
|
|
19593
|
+
} | undefined;
|
|
19594
|
+
is_managed: false;
|
|
19595
|
+
}) | null;
|
|
17162
19596
|
};
|
|
17163
19597
|
} | {
|
|
17164
19598
|
/** The ID of the action attempt. */
|
|
17165
19599
|
action_attempt_id: string;
|
|
17166
19600
|
status: 'error';
|
|
17167
19601
|
result: null;
|
|
17168
|
-
action_type: '
|
|
19602
|
+
action_type: 'SCAN_CARD';
|
|
17169
19603
|
error: {
|
|
17170
19604
|
type: 'no_card_on_encoder';
|
|
17171
19605
|
message: string;
|
|
@@ -19072,23 +21506,128 @@ export interface Routes {
|
|
|
19072
21506
|
status: 'pending';
|
|
19073
21507
|
result: null;
|
|
19074
21508
|
error: null;
|
|
19075
|
-
action_type: '
|
|
21509
|
+
action_type: 'SCAN_CARD';
|
|
19076
21510
|
} | {
|
|
19077
21511
|
/** The ID of the action attempt. */
|
|
19078
21512
|
action_attempt_id: string;
|
|
19079
21513
|
status: 'success';
|
|
19080
21514
|
error: null;
|
|
19081
|
-
action_type: '
|
|
21515
|
+
action_type: 'SCAN_CARD';
|
|
19082
21516
|
result: {
|
|
19083
|
-
/**
|
|
19084
|
-
|
|
21517
|
+
/** Snapshot of the card data read from the physical encoder. */
|
|
21518
|
+
acs_credential_on_encoder: {
|
|
21519
|
+
/** Date and time the credential was created. */
|
|
21520
|
+
created_at: string;
|
|
21521
|
+
is_issued: boolean | null;
|
|
21522
|
+
/** Date and time the credential will become useable. */
|
|
21523
|
+
starts_at: string | null;
|
|
21524
|
+
/** Date and time the credential will stop being useable. */
|
|
21525
|
+
ends_at: string | null;
|
|
21526
|
+
/** A number or string that physically identifies this card. */
|
|
21527
|
+
card_number: string | null;
|
|
21528
|
+
visionline_metadata?: {
|
|
21529
|
+
card_id: string;
|
|
21530
|
+
card_function_type: 'guest' | 'staff';
|
|
21531
|
+
cancelled: boolean;
|
|
21532
|
+
discarded: boolean;
|
|
21533
|
+
expired: boolean;
|
|
21534
|
+
overwritten: boolean;
|
|
21535
|
+
overridden?: boolean | undefined;
|
|
21536
|
+
pending_auto_update: boolean;
|
|
21537
|
+
card_format: 'TLCode' | 'rfid48';
|
|
21538
|
+
card_holder?: string | undefined;
|
|
21539
|
+
number_of_issued_cards: number;
|
|
21540
|
+
} | undefined;
|
|
21541
|
+
};
|
|
21542
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
21543
|
+
acs_credential_on_seam: ({
|
|
21544
|
+
acs_credential_id: string;
|
|
21545
|
+
acs_user_id?: string | undefined;
|
|
21546
|
+
acs_credential_pool_id?: string | undefined;
|
|
21547
|
+
acs_system_id: string;
|
|
21548
|
+
parent_acs_credential_id?: string | undefined;
|
|
21549
|
+
display_name: string;
|
|
21550
|
+
code?: (string | undefined) | null;
|
|
21551
|
+
card_number?: (string | undefined) | null;
|
|
21552
|
+
is_issued?: boolean | undefined;
|
|
21553
|
+
issued_at?: (string | undefined) | null;
|
|
21554
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
21555
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
21556
|
+
external_type_display_name?: string | undefined;
|
|
21557
|
+
created_at: string;
|
|
21558
|
+
workspace_id: string;
|
|
21559
|
+
starts_at?: string | undefined;
|
|
21560
|
+
ends_at?: string | undefined;
|
|
21561
|
+
errors: Array<{
|
|
21562
|
+
error_code: string;
|
|
21563
|
+
message: string;
|
|
21564
|
+
}>;
|
|
21565
|
+
warnings: Array<{
|
|
21566
|
+
warning_code: string;
|
|
21567
|
+
message: string;
|
|
21568
|
+
}>;
|
|
21569
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
21570
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
21571
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
21572
|
+
visionline_metadata?: {
|
|
21573
|
+
card_function_type: 'guest' | 'staff';
|
|
21574
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
21575
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
21576
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
21577
|
+
is_valid?: boolean | undefined;
|
|
21578
|
+
auto_join?: boolean | undefined;
|
|
21579
|
+
card_id?: string | undefined;
|
|
21580
|
+
credential_id?: string | undefined;
|
|
21581
|
+
} | undefined;
|
|
21582
|
+
is_managed: true;
|
|
21583
|
+
} | {
|
|
21584
|
+
acs_credential_id: string;
|
|
21585
|
+
acs_user_id?: string | undefined;
|
|
21586
|
+
acs_credential_pool_id?: string | undefined;
|
|
21587
|
+
acs_system_id: string;
|
|
21588
|
+
parent_acs_credential_id?: string | undefined;
|
|
21589
|
+
display_name: string;
|
|
21590
|
+
code?: (string | undefined) | null;
|
|
21591
|
+
card_number?: (string | undefined) | null;
|
|
21592
|
+
is_issued?: boolean | undefined;
|
|
21593
|
+
issued_at?: (string | undefined) | null;
|
|
21594
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
21595
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
21596
|
+
external_type_display_name?: string | undefined;
|
|
21597
|
+
created_at: string;
|
|
21598
|
+
workspace_id: string;
|
|
21599
|
+
starts_at?: string | undefined;
|
|
21600
|
+
ends_at?: string | undefined;
|
|
21601
|
+
errors: Array<{
|
|
21602
|
+
error_code: string;
|
|
21603
|
+
message: string;
|
|
21604
|
+
}>;
|
|
21605
|
+
warnings: Array<{
|
|
21606
|
+
warning_code: string;
|
|
21607
|
+
message: string;
|
|
21608
|
+
}>;
|
|
21609
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
21610
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
21611
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
21612
|
+
visionline_metadata?: {
|
|
21613
|
+
card_function_type: 'guest' | 'staff';
|
|
21614
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
21615
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
21616
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
21617
|
+
is_valid?: boolean | undefined;
|
|
21618
|
+
auto_join?: boolean | undefined;
|
|
21619
|
+
card_id?: string | undefined;
|
|
21620
|
+
credential_id?: string | undefined;
|
|
21621
|
+
} | undefined;
|
|
21622
|
+
is_managed: false;
|
|
21623
|
+
}) | null;
|
|
19085
21624
|
};
|
|
19086
21625
|
} | {
|
|
19087
21626
|
/** The ID of the action attempt. */
|
|
19088
21627
|
action_attempt_id: string;
|
|
19089
21628
|
status: 'error';
|
|
19090
21629
|
result: null;
|
|
19091
|
-
action_type: '
|
|
21630
|
+
action_type: 'SCAN_CARD';
|
|
19092
21631
|
error: {
|
|
19093
21632
|
type: 'no_card_on_encoder';
|
|
19094
21633
|
message: string;
|