@seamapi/http 1.11.1 → 1.13.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.
Files changed (16) hide show
  1. package/dist/connect.cjs +12 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +340 -36
  4. package/lib/seam/connect/resolve-action-attempt.d.ts +444 -44
  5. package/lib/seam/connect/routes/acs-encoders.d.ts +8 -8
  6. package/lib/seam/connect/routes/acs-encoders.js +4 -4
  7. package/lib/seam/connect/routes/acs-encoders.js.map +1 -1
  8. package/lib/seam/connect/routes/thermostats.d.ts +4 -0
  9. package/lib/seam/connect/routes/thermostats.js +8 -0
  10. package/lib/seam/connect/routes/thermostats.js.map +1 -1
  11. package/lib/version.d.ts +1 -1
  12. package/lib/version.js +1 -1
  13. package/package.json +3 -3
  14. package/src/lib/seam/connect/routes/acs-encoders.ts +18 -18
  15. package/src/lib/seam/connect/routes/thermostats.ts +20 -0
  16. package/src/lib/version.ts +1 -1
package/lib/seam/connect/resolve-action-attempt.d.ts CHANGED
@@ -51,12 +51,16 @@ export declare const resolveActionAttempt: <T extends {
51
51
  status: "pending";
52
52
  action_attempt_id: string;
53
53
  result: null;
54
- action_type: "SCAN_CARD";
54
+ action_type: "SCAN_CREDENTIAL";
55
55
  } | {
56
56
  error: null;
57
57
  status: "success";
58
58
  action_attempt_id: string;
59
59
  result: {
60
+ warnings: {
61
+ warning_code: "acs_credential_on_encoder_out_of_sync";
62
+ warning_message: string;
63
+ }[];
60
64
  acs_credential_on_encoder: {
61
65
  created_at: string | null;
62
66
  starts_at: string | null;
@@ -65,7 +69,6 @@ export declare const resolveActionAttempt: <T extends {
65
69
  is_issued: boolean | null;
66
70
  visionline_metadata?: {
67
71
  expired: boolean;
68
- card_function_type: "guest" | "staff";
69
72
  card_id: string;
70
73
  cancelled: boolean;
71
74
  discarded: boolean;
@@ -73,6 +76,8 @@ export declare const resolveActionAttempt: <T extends {
73
76
  pending_auto_update: boolean;
74
77
  card_format: "TLCode" | "rfid48";
75
78
  number_of_issued_cards: number;
79
+ guest_acs_entrance_ids?: string[] | undefined;
80
+ common_acs_entrance_ids?: string[] | undefined;
76
81
  overridden?: boolean | undefined;
77
82
  card_holder?: string | undefined;
78
83
  } | undefined;
@@ -159,37 +164,132 @@ export declare const resolveActionAttempt: <T extends {
159
164
  latest_desired_state_synced_with_provider_at?: string | undefined;
160
165
  } | null;
161
166
  };
162
- action_type: "SCAN_CARD";
167
+ action_type: "SCAN_CREDENTIAL";
163
168
  } | {
164
169
  error: {
170
+ type: "uncategorized_error";
171
+ message: string;
172
+ } | {
173
+ type: "action_attempt_expired";
174
+ message: string;
175
+ } | {
165
176
  type: "no_card_on_encoder";
166
177
  message: string;
167
178
  };
168
179
  status: "error";
169
180
  action_attempt_id: string;
170
181
  result: null;
171
- action_type: "SCAN_CARD";
182
+ action_type: "SCAN_CREDENTIAL";
172
183
  } | {
173
184
  error: null;
174
185
  status: "pending";
175
186
  action_attempt_id: string;
176
187
  result: null;
177
- action_type: "ENCODE_CARD";
188
+ action_type: "ENCODE_CREDENTIAL";
178
189
  } | {
179
190
  error: null;
180
191
  status: "success";
181
192
  action_attempt_id: string;
182
- result: {};
183
- action_type: "ENCODE_CARD";
184
- } | {
185
- error: {
186
- type: string;
193
+ result: {
194
+ created_at: string;
195
+ errors: {
196
+ message: string;
197
+ error_code: string;
198
+ }[];
199
+ warnings: {
200
+ message: string;
201
+ warning_code: string;
202
+ }[];
203
+ display_name: string;
204
+ workspace_id: string;
205
+ is_managed: true;
206
+ acs_system_id: string;
207
+ acs_credential_id: string;
208
+ access_method: "code" | "card" | "mobile_key";
209
+ code?: string | null | undefined;
210
+ starts_at?: string | undefined;
211
+ ends_at?: string | undefined;
212
+ visionline_metadata?: {
213
+ card_function_type: "guest" | "staff";
214
+ joiner_acs_credential_ids?: string[] | undefined;
215
+ guest_acs_entrance_ids?: string[] | undefined;
216
+ common_acs_entrance_ids?: string[] | undefined;
217
+ is_valid?: boolean | undefined;
218
+ auto_join?: boolean | undefined;
219
+ card_id?: string | undefined;
220
+ credential_id?: string | undefined;
221
+ } | undefined;
222
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
223
+ external_type_display_name?: string | undefined;
224
+ acs_user_id?: string | undefined;
225
+ acs_credential_pool_id?: string | undefined;
226
+ parent_acs_credential_id?: string | undefined;
227
+ card_number?: string | null | undefined;
228
+ is_issued?: boolean | undefined;
229
+ issued_at?: string | null | undefined;
230
+ is_multi_phone_sync_credential?: boolean | undefined;
231
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
232
+ latest_desired_state_synced_with_provider_at?: string | undefined;
233
+ } | {
234
+ created_at: string;
235
+ errors: {
236
+ message: string;
237
+ error_code: string;
238
+ }[];
239
+ warnings: {
240
+ message: string;
241
+ warning_code: string;
242
+ }[];
243
+ display_name: string;
244
+ workspace_id: string;
245
+ is_managed: false;
246
+ acs_system_id: string;
247
+ acs_credential_id: string;
248
+ access_method: "code" | "card" | "mobile_key";
249
+ code?: string | null | undefined;
250
+ starts_at?: string | undefined;
251
+ ends_at?: string | undefined;
252
+ visionline_metadata?: {
253
+ card_function_type: "guest" | "staff";
254
+ joiner_acs_credential_ids?: string[] | undefined;
255
+ guest_acs_entrance_ids?: string[] | undefined;
256
+ common_acs_entrance_ids?: string[] | undefined;
257
+ is_valid?: boolean | undefined;
258
+ auto_join?: boolean | undefined;
259
+ card_id?: string | undefined;
260
+ credential_id?: string | undefined;
261
+ } | undefined;
262
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
263
+ external_type_display_name?: string | undefined;
264
+ acs_user_id?: string | undefined;
265
+ acs_credential_pool_id?: string | undefined;
266
+ parent_acs_credential_id?: string | undefined;
267
+ card_number?: string | null | undefined;
268
+ is_issued?: boolean | undefined;
269
+ issued_at?: string | null | undefined;
270
+ is_multi_phone_sync_credential?: boolean | undefined;
271
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
272
+ latest_desired_state_synced_with_provider_at?: string | undefined;
273
+ };
274
+ action_type: "ENCODE_CREDENTIAL";
275
+ } | {
276
+ error: {
277
+ type: "uncategorized_error";
278
+ message: string;
279
+ } | {
280
+ type: "action_attempt_expired";
281
+ message: string;
282
+ } | {
283
+ type: "no_card_on_encoder";
284
+ message: string;
285
+ } | {
286
+ type: "incompatible_card_format";
187
287
  message: string;
188
288
  };
189
289
  status: "error";
190
290
  action_attempt_id: string;
191
291
  result: null;
192
- action_type: "ENCODE_CARD";
292
+ action_type: "ENCODE_CREDENTIAL";
193
293
  } | {
194
294
  error: null;
195
295
  status: "pending";
@@ -542,12 +642,16 @@ export declare const isSeamActionAttemptError: <T extends {
542
642
  status: "pending";
543
643
  action_attempt_id: string;
544
644
  result: null;
545
- action_type: "SCAN_CARD";
645
+ action_type: "SCAN_CREDENTIAL";
546
646
  } | {
547
647
  error: null;
548
648
  status: "success";
549
649
  action_attempt_id: string;
550
650
  result: {
651
+ warnings: {
652
+ warning_code: "acs_credential_on_encoder_out_of_sync";
653
+ warning_message: string;
654
+ }[];
551
655
  acs_credential_on_encoder: {
552
656
  created_at: string | null;
553
657
  starts_at: string | null;
@@ -556,7 +660,6 @@ export declare const isSeamActionAttemptError: <T extends {
556
660
  is_issued: boolean | null;
557
661
  visionline_metadata?: {
558
662
  expired: boolean;
559
- card_function_type: "guest" | "staff";
560
663
  card_id: string;
561
664
  cancelled: boolean;
562
665
  discarded: boolean;
@@ -564,6 +667,8 @@ export declare const isSeamActionAttemptError: <T extends {
564
667
  pending_auto_update: boolean;
565
668
  card_format: "TLCode" | "rfid48";
566
669
  number_of_issued_cards: number;
670
+ guest_acs_entrance_ids?: string[] | undefined;
671
+ common_acs_entrance_ids?: string[] | undefined;
567
672
  overridden?: boolean | undefined;
568
673
  card_holder?: string | undefined;
569
674
  } | undefined;
@@ -650,37 +755,132 @@ export declare const isSeamActionAttemptError: <T extends {
650
755
  latest_desired_state_synced_with_provider_at?: string | undefined;
651
756
  } | null;
652
757
  };
653
- action_type: "SCAN_CARD";
758
+ action_type: "SCAN_CREDENTIAL";
654
759
  } | {
655
760
  error: {
761
+ type: "uncategorized_error";
762
+ message: string;
763
+ } | {
764
+ type: "action_attempt_expired";
765
+ message: string;
766
+ } | {
656
767
  type: "no_card_on_encoder";
657
768
  message: string;
658
769
  };
659
770
  status: "error";
660
771
  action_attempt_id: string;
661
772
  result: null;
662
- action_type: "SCAN_CARD";
773
+ action_type: "SCAN_CREDENTIAL";
663
774
  } | {
664
775
  error: null;
665
776
  status: "pending";
666
777
  action_attempt_id: string;
667
778
  result: null;
668
- action_type: "ENCODE_CARD";
779
+ action_type: "ENCODE_CREDENTIAL";
669
780
  } | {
670
781
  error: null;
671
782
  status: "success";
672
783
  action_attempt_id: string;
673
- result: {};
674
- action_type: "ENCODE_CARD";
675
- } | {
676
- error: {
677
- type: string;
784
+ result: {
785
+ created_at: string;
786
+ errors: {
787
+ message: string;
788
+ error_code: string;
789
+ }[];
790
+ warnings: {
791
+ message: string;
792
+ warning_code: string;
793
+ }[];
794
+ display_name: string;
795
+ workspace_id: string;
796
+ is_managed: true;
797
+ acs_system_id: string;
798
+ acs_credential_id: string;
799
+ access_method: "code" | "card" | "mobile_key";
800
+ code?: string | null | undefined;
801
+ starts_at?: string | undefined;
802
+ ends_at?: string | undefined;
803
+ visionline_metadata?: {
804
+ card_function_type: "guest" | "staff";
805
+ joiner_acs_credential_ids?: string[] | undefined;
806
+ guest_acs_entrance_ids?: string[] | undefined;
807
+ common_acs_entrance_ids?: string[] | undefined;
808
+ is_valid?: boolean | undefined;
809
+ auto_join?: boolean | undefined;
810
+ card_id?: string | undefined;
811
+ credential_id?: string | undefined;
812
+ } | undefined;
813
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
814
+ external_type_display_name?: string | undefined;
815
+ acs_user_id?: string | undefined;
816
+ acs_credential_pool_id?: string | undefined;
817
+ parent_acs_credential_id?: string | undefined;
818
+ card_number?: string | null | undefined;
819
+ is_issued?: boolean | undefined;
820
+ issued_at?: string | null | undefined;
821
+ is_multi_phone_sync_credential?: boolean | undefined;
822
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
823
+ latest_desired_state_synced_with_provider_at?: string | undefined;
824
+ } | {
825
+ created_at: string;
826
+ errors: {
827
+ message: string;
828
+ error_code: string;
829
+ }[];
830
+ warnings: {
831
+ message: string;
832
+ warning_code: string;
833
+ }[];
834
+ display_name: string;
835
+ workspace_id: string;
836
+ is_managed: false;
837
+ acs_system_id: string;
838
+ acs_credential_id: string;
839
+ access_method: "code" | "card" | "mobile_key";
840
+ code?: string | null | undefined;
841
+ starts_at?: string | undefined;
842
+ ends_at?: string | undefined;
843
+ visionline_metadata?: {
844
+ card_function_type: "guest" | "staff";
845
+ joiner_acs_credential_ids?: string[] | undefined;
846
+ guest_acs_entrance_ids?: string[] | undefined;
847
+ common_acs_entrance_ids?: string[] | undefined;
848
+ is_valid?: boolean | undefined;
849
+ auto_join?: boolean | undefined;
850
+ card_id?: string | undefined;
851
+ credential_id?: string | undefined;
852
+ } | undefined;
853
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
854
+ external_type_display_name?: string | undefined;
855
+ acs_user_id?: string | undefined;
856
+ acs_credential_pool_id?: string | undefined;
857
+ parent_acs_credential_id?: string | undefined;
858
+ card_number?: string | null | undefined;
859
+ is_issued?: boolean | undefined;
860
+ issued_at?: string | null | undefined;
861
+ is_multi_phone_sync_credential?: boolean | undefined;
862
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
863
+ latest_desired_state_synced_with_provider_at?: string | undefined;
864
+ };
865
+ action_type: "ENCODE_CREDENTIAL";
866
+ } | {
867
+ error: {
868
+ type: "uncategorized_error";
869
+ message: string;
870
+ } | {
871
+ type: "action_attempt_expired";
872
+ message: string;
873
+ } | {
874
+ type: "no_card_on_encoder";
875
+ message: string;
876
+ } | {
877
+ type: "incompatible_card_format";
678
878
  message: string;
679
879
  };
680
880
  status: "error";
681
881
  action_attempt_id: string;
682
882
  result: null;
683
- action_type: "ENCODE_CARD";
883
+ action_type: "ENCODE_CREDENTIAL";
684
884
  } | {
685
885
  error: null;
686
886
  status: "pending";
@@ -1035,12 +1235,16 @@ export declare const isSeamActionAttemptFailedError: <T extends {
1035
1235
  status: "pending";
1036
1236
  action_attempt_id: string;
1037
1237
  result: null;
1038
- action_type: "SCAN_CARD";
1238
+ action_type: "SCAN_CREDENTIAL";
1039
1239
  } | {
1040
1240
  error: null;
1041
1241
  status: "success";
1042
1242
  action_attempt_id: string;
1043
1243
  result: {
1244
+ warnings: {
1245
+ warning_code: "acs_credential_on_encoder_out_of_sync";
1246
+ warning_message: string;
1247
+ }[];
1044
1248
  acs_credential_on_encoder: {
1045
1249
  created_at: string | null;
1046
1250
  starts_at: string | null;
@@ -1049,7 +1253,6 @@ export declare const isSeamActionAttemptFailedError: <T extends {
1049
1253
  is_issued: boolean | null;
1050
1254
  visionline_metadata?: {
1051
1255
  expired: boolean;
1052
- card_function_type: "guest" | "staff";
1053
1256
  card_id: string;
1054
1257
  cancelled: boolean;
1055
1258
  discarded: boolean;
@@ -1057,6 +1260,8 @@ export declare const isSeamActionAttemptFailedError: <T extends {
1057
1260
  pending_auto_update: boolean;
1058
1261
  card_format: "TLCode" | "rfid48";
1059
1262
  number_of_issued_cards: number;
1263
+ guest_acs_entrance_ids?: string[] | undefined;
1264
+ common_acs_entrance_ids?: string[] | undefined;
1060
1265
  overridden?: boolean | undefined;
1061
1266
  card_holder?: string | undefined;
1062
1267
  } | undefined;
@@ -1143,37 +1348,132 @@ export declare const isSeamActionAttemptFailedError: <T extends {
1143
1348
  latest_desired_state_synced_with_provider_at?: string | undefined;
1144
1349
  } | null;
1145
1350
  };
1146
- action_type: "SCAN_CARD";
1351
+ action_type: "SCAN_CREDENTIAL";
1147
1352
  } | {
1148
1353
  error: {
1354
+ type: "uncategorized_error";
1355
+ message: string;
1356
+ } | {
1357
+ type: "action_attempt_expired";
1358
+ message: string;
1359
+ } | {
1149
1360
  type: "no_card_on_encoder";
1150
1361
  message: string;
1151
1362
  };
1152
1363
  status: "error";
1153
1364
  action_attempt_id: string;
1154
1365
  result: null;
1155
- action_type: "SCAN_CARD";
1366
+ action_type: "SCAN_CREDENTIAL";
1156
1367
  } | {
1157
1368
  error: null;
1158
1369
  status: "pending";
1159
1370
  action_attempt_id: string;
1160
1371
  result: null;
1161
- action_type: "ENCODE_CARD";
1372
+ action_type: "ENCODE_CREDENTIAL";
1162
1373
  } | {
1163
1374
  error: null;
1164
1375
  status: "success";
1165
1376
  action_attempt_id: string;
1166
- result: {};
1167
- action_type: "ENCODE_CARD";
1168
- } | {
1169
- error: {
1170
- type: string;
1377
+ result: {
1378
+ created_at: string;
1379
+ errors: {
1380
+ message: string;
1381
+ error_code: string;
1382
+ }[];
1383
+ warnings: {
1384
+ message: string;
1385
+ warning_code: string;
1386
+ }[];
1387
+ display_name: string;
1388
+ workspace_id: string;
1389
+ is_managed: true;
1390
+ acs_system_id: string;
1391
+ acs_credential_id: string;
1392
+ access_method: "code" | "card" | "mobile_key";
1393
+ code?: string | null | undefined;
1394
+ starts_at?: string | undefined;
1395
+ ends_at?: string | undefined;
1396
+ visionline_metadata?: {
1397
+ card_function_type: "guest" | "staff";
1398
+ joiner_acs_credential_ids?: string[] | undefined;
1399
+ guest_acs_entrance_ids?: string[] | undefined;
1400
+ common_acs_entrance_ids?: string[] | undefined;
1401
+ is_valid?: boolean | undefined;
1402
+ auto_join?: boolean | undefined;
1403
+ card_id?: string | undefined;
1404
+ credential_id?: string | undefined;
1405
+ } | undefined;
1406
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
1407
+ external_type_display_name?: string | undefined;
1408
+ acs_user_id?: string | undefined;
1409
+ acs_credential_pool_id?: string | undefined;
1410
+ parent_acs_credential_id?: string | undefined;
1411
+ card_number?: string | null | undefined;
1412
+ is_issued?: boolean | undefined;
1413
+ issued_at?: string | null | undefined;
1414
+ is_multi_phone_sync_credential?: boolean | undefined;
1415
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
1416
+ latest_desired_state_synced_with_provider_at?: string | undefined;
1417
+ } | {
1418
+ created_at: string;
1419
+ errors: {
1420
+ message: string;
1421
+ error_code: string;
1422
+ }[];
1423
+ warnings: {
1424
+ message: string;
1425
+ warning_code: string;
1426
+ }[];
1427
+ display_name: string;
1428
+ workspace_id: string;
1429
+ is_managed: false;
1430
+ acs_system_id: string;
1431
+ acs_credential_id: string;
1432
+ access_method: "code" | "card" | "mobile_key";
1433
+ code?: string | null | undefined;
1434
+ starts_at?: string | undefined;
1435
+ ends_at?: string | undefined;
1436
+ visionline_metadata?: {
1437
+ card_function_type: "guest" | "staff";
1438
+ joiner_acs_credential_ids?: string[] | undefined;
1439
+ guest_acs_entrance_ids?: string[] | undefined;
1440
+ common_acs_entrance_ids?: string[] | undefined;
1441
+ is_valid?: boolean | undefined;
1442
+ auto_join?: boolean | undefined;
1443
+ card_id?: string | undefined;
1444
+ credential_id?: string | undefined;
1445
+ } | undefined;
1446
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
1447
+ external_type_display_name?: string | undefined;
1448
+ acs_user_id?: string | undefined;
1449
+ acs_credential_pool_id?: string | undefined;
1450
+ parent_acs_credential_id?: string | undefined;
1451
+ card_number?: string | null | undefined;
1452
+ is_issued?: boolean | undefined;
1453
+ issued_at?: string | null | undefined;
1454
+ is_multi_phone_sync_credential?: boolean | undefined;
1455
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
1456
+ latest_desired_state_synced_with_provider_at?: string | undefined;
1457
+ };
1458
+ action_type: "ENCODE_CREDENTIAL";
1459
+ } | {
1460
+ error: {
1461
+ type: "uncategorized_error";
1462
+ message: string;
1463
+ } | {
1464
+ type: "action_attempt_expired";
1465
+ message: string;
1466
+ } | {
1467
+ type: "no_card_on_encoder";
1468
+ message: string;
1469
+ } | {
1470
+ type: "incompatible_card_format";
1171
1471
  message: string;
1172
1472
  };
1173
1473
  status: "error";
1174
1474
  action_attempt_id: string;
1175
1475
  result: null;
1176
- action_type: "ENCODE_CARD";
1476
+ action_type: "ENCODE_CREDENTIAL";
1177
1477
  } | {
1178
1478
  error: null;
1179
1479
  status: "pending";
@@ -1528,12 +1828,16 @@ export declare const isSeamActionAttemptTimeoutError: <T extends {
1528
1828
  status: "pending";
1529
1829
  action_attempt_id: string;
1530
1830
  result: null;
1531
- action_type: "SCAN_CARD";
1831
+ action_type: "SCAN_CREDENTIAL";
1532
1832
  } | {
1533
1833
  error: null;
1534
1834
  status: "success";
1535
1835
  action_attempt_id: string;
1536
1836
  result: {
1837
+ warnings: {
1838
+ warning_code: "acs_credential_on_encoder_out_of_sync";
1839
+ warning_message: string;
1840
+ }[];
1537
1841
  acs_credential_on_encoder: {
1538
1842
  created_at: string | null;
1539
1843
  starts_at: string | null;
@@ -1542,7 +1846,6 @@ export declare const isSeamActionAttemptTimeoutError: <T extends {
1542
1846
  is_issued: boolean | null;
1543
1847
  visionline_metadata?: {
1544
1848
  expired: boolean;
1545
- card_function_type: "guest" | "staff";
1546
1849
  card_id: string;
1547
1850
  cancelled: boolean;
1548
1851
  discarded: boolean;
@@ -1550,6 +1853,8 @@ export declare const isSeamActionAttemptTimeoutError: <T extends {
1550
1853
  pending_auto_update: boolean;
1551
1854
  card_format: "TLCode" | "rfid48";
1552
1855
  number_of_issued_cards: number;
1856
+ guest_acs_entrance_ids?: string[] | undefined;
1857
+ common_acs_entrance_ids?: string[] | undefined;
1553
1858
  overridden?: boolean | undefined;
1554
1859
  card_holder?: string | undefined;
1555
1860
  } | undefined;
@@ -1636,37 +1941,132 @@ export declare const isSeamActionAttemptTimeoutError: <T extends {
1636
1941
  latest_desired_state_synced_with_provider_at?: string | undefined;
1637
1942
  } | null;
1638
1943
  };
1639
- action_type: "SCAN_CARD";
1944
+ action_type: "SCAN_CREDENTIAL";
1640
1945
  } | {
1641
1946
  error: {
1947
+ type: "uncategorized_error";
1948
+ message: string;
1949
+ } | {
1950
+ type: "action_attempt_expired";
1951
+ message: string;
1952
+ } | {
1642
1953
  type: "no_card_on_encoder";
1643
1954
  message: string;
1644
1955
  };
1645
1956
  status: "error";
1646
1957
  action_attempt_id: string;
1647
1958
  result: null;
1648
- action_type: "SCAN_CARD";
1959
+ action_type: "SCAN_CREDENTIAL";
1649
1960
  } | {
1650
1961
  error: null;
1651
1962
  status: "pending";
1652
1963
  action_attempt_id: string;
1653
1964
  result: null;
1654
- action_type: "ENCODE_CARD";
1965
+ action_type: "ENCODE_CREDENTIAL";
1655
1966
  } | {
1656
1967
  error: null;
1657
1968
  status: "success";
1658
1969
  action_attempt_id: string;
1659
- result: {};
1660
- action_type: "ENCODE_CARD";
1661
- } | {
1662
- error: {
1663
- type: string;
1970
+ result: {
1971
+ created_at: string;
1972
+ errors: {
1973
+ message: string;
1974
+ error_code: string;
1975
+ }[];
1976
+ warnings: {
1977
+ message: string;
1978
+ warning_code: string;
1979
+ }[];
1980
+ display_name: string;
1981
+ workspace_id: string;
1982
+ is_managed: true;
1983
+ acs_system_id: string;
1984
+ acs_credential_id: string;
1985
+ access_method: "code" | "card" | "mobile_key";
1986
+ code?: string | null | undefined;
1987
+ starts_at?: string | undefined;
1988
+ ends_at?: string | undefined;
1989
+ visionline_metadata?: {
1990
+ card_function_type: "guest" | "staff";
1991
+ joiner_acs_credential_ids?: string[] | undefined;
1992
+ guest_acs_entrance_ids?: string[] | undefined;
1993
+ common_acs_entrance_ids?: string[] | undefined;
1994
+ is_valid?: boolean | undefined;
1995
+ auto_join?: boolean | undefined;
1996
+ card_id?: string | undefined;
1997
+ credential_id?: string | undefined;
1998
+ } | undefined;
1999
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
2000
+ external_type_display_name?: string | undefined;
2001
+ acs_user_id?: string | undefined;
2002
+ acs_credential_pool_id?: string | undefined;
2003
+ parent_acs_credential_id?: string | undefined;
2004
+ card_number?: string | null | undefined;
2005
+ is_issued?: boolean | undefined;
2006
+ issued_at?: string | null | undefined;
2007
+ is_multi_phone_sync_credential?: boolean | undefined;
2008
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
2009
+ latest_desired_state_synced_with_provider_at?: string | undefined;
2010
+ } | {
2011
+ created_at: string;
2012
+ errors: {
2013
+ message: string;
2014
+ error_code: string;
2015
+ }[];
2016
+ warnings: {
2017
+ message: string;
2018
+ warning_code: string;
2019
+ }[];
2020
+ display_name: string;
2021
+ workspace_id: string;
2022
+ is_managed: false;
2023
+ acs_system_id: string;
2024
+ acs_credential_id: string;
2025
+ access_method: "code" | "card" | "mobile_key";
2026
+ code?: string | null | undefined;
2027
+ starts_at?: string | undefined;
2028
+ ends_at?: string | undefined;
2029
+ visionline_metadata?: {
2030
+ card_function_type: "guest" | "staff";
2031
+ joiner_acs_credential_ids?: string[] | undefined;
2032
+ guest_acs_entrance_ids?: string[] | undefined;
2033
+ common_acs_entrance_ids?: string[] | undefined;
2034
+ is_valid?: boolean | undefined;
2035
+ auto_join?: boolean | undefined;
2036
+ card_id?: string | undefined;
2037
+ credential_id?: string | undefined;
2038
+ } | undefined;
2039
+ external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" | undefined;
2040
+ external_type_display_name?: string | undefined;
2041
+ acs_user_id?: string | undefined;
2042
+ acs_credential_pool_id?: string | undefined;
2043
+ parent_acs_credential_id?: string | undefined;
2044
+ card_number?: string | null | undefined;
2045
+ is_issued?: boolean | undefined;
2046
+ issued_at?: string | null | undefined;
2047
+ is_multi_phone_sync_credential?: boolean | undefined;
2048
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
2049
+ latest_desired_state_synced_with_provider_at?: string | undefined;
2050
+ };
2051
+ action_type: "ENCODE_CREDENTIAL";
2052
+ } | {
2053
+ error: {
2054
+ type: "uncategorized_error";
2055
+ message: string;
2056
+ } | {
2057
+ type: "action_attempt_expired";
2058
+ message: string;
2059
+ } | {
2060
+ type: "no_card_on_encoder";
2061
+ message: string;
2062
+ } | {
2063
+ type: "incompatible_card_format";
1664
2064
  message: string;
1665
2065
  };
1666
2066
  status: "error";
1667
2067
  action_attempt_id: string;
1668
2068
  result: null;
1669
- action_type: "ENCODE_CARD";
2069
+ action_type: "ENCODE_CREDENTIAL";
1670
2070
  } | {
1671
2071
  error: null;
1672
2072
  status: "pending";