@seamapi/types 1.313.0 → 1.314.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.
@@ -306,7 +306,7 @@ export interface Routes {
306
306
  type: 'action_attempt_expired';
307
307
  message: string;
308
308
  } | {
309
- type: 'no_card_on_encoder';
309
+ type: 'no_credential_on_encoder';
310
310
  message: string;
311
311
  };
312
312
  } | {
@@ -510,7 +510,7 @@ export interface Routes {
510
510
  type: 'action_attempt_expired';
511
511
  message: string;
512
512
  } | {
513
- type: 'no_card_on_encoder';
513
+ type: 'no_credential_on_encoder';
514
514
  message: string;
515
515
  } | {
516
516
  type: 'incompatible_card_format';
@@ -1233,7 +1233,7 @@ export interface Routes {
1233
1233
  type: 'action_attempt_expired';
1234
1234
  message: string;
1235
1235
  } | {
1236
- type: 'no_card_on_encoder';
1236
+ type: 'no_credential_on_encoder';
1237
1237
  message: string;
1238
1238
  };
1239
1239
  } | {
@@ -1437,7 +1437,7 @@ export interface Routes {
1437
1437
  type: 'action_attempt_expired';
1438
1438
  message: string;
1439
1439
  } | {
1440
- type: 'no_card_on_encoder';
1440
+ type: 'no_credential_on_encoder';
1441
1441
  message: string;
1442
1442
  } | {
1443
1443
  type: 'incompatible_card_format';
@@ -2378,7 +2378,7 @@ export interface Routes {
2378
2378
  type: 'action_attempt_expired';
2379
2379
  message: string;
2380
2380
  } | {
2381
- type: 'no_card_on_encoder';
2381
+ type: 'no_credential_on_encoder';
2382
2382
  message: string;
2383
2383
  };
2384
2384
  } | {
@@ -2582,7 +2582,7 @@ export interface Routes {
2582
2582
  type: 'action_attempt_expired';
2583
2583
  message: string;
2584
2584
  } | {
2585
- type: 'no_card_on_encoder';
2585
+ type: 'no_credential_on_encoder';
2586
2586
  message: string;
2587
2587
  } | {
2588
2588
  type: 'incompatible_card_format';
@@ -3292,7 +3292,7 @@ export interface Routes {
3292
3292
  type: 'action_attempt_expired';
3293
3293
  message: string;
3294
3294
  } | {
3295
- type: 'no_card_on_encoder';
3295
+ type: 'no_credential_on_encoder';
3296
3296
  message: string;
3297
3297
  };
3298
3298
  } | {
@@ -3496,7 +3496,7 @@ export interface Routes {
3496
3496
  type: 'action_attempt_expired';
3497
3497
  message: string;
3498
3498
  } | {
3499
- type: 'no_card_on_encoder';
3499
+ type: 'no_credential_on_encoder';
3500
3500
  message: string;
3501
3501
  } | {
3502
3502
  type: 'incompatible_card_format';
@@ -3829,13 +3829,13 @@ export interface Routes {
3829
3829
  name: string;
3830
3830
  /**
3831
3831
  * @deprecated Use `external_type`. */
3832
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
3832
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
3833
3833
  /**
3834
3834
  * @deprecated Use `external_type_display_name`. */
3835
3835
  access_group_type_display_name: string;
3836
3836
  display_name: string;
3837
3837
  /** Brand-specific terminology for the access group type. */
3838
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
3838
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
3839
3839
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
3840
3840
  external_type_display_name: string;
3841
3841
  /** Date and time at which the access group was created. */
@@ -3868,13 +3868,13 @@ export interface Routes {
3868
3868
  name: string;
3869
3869
  /**
3870
3870
  * @deprecated Use `external_type`. */
3871
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
3871
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
3872
3872
  /**
3873
3873
  * @deprecated Use `external_type_display_name`. */
3874
3874
  access_group_type_display_name: string;
3875
3875
  display_name: string;
3876
3876
  /** Brand-specific terminology for the access group type. */
3877
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
3877
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
3878
3878
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
3879
3879
  external_type_display_name: string;
3880
3880
  /** Date and time at which the access group was created. */
@@ -4090,13 +4090,13 @@ export interface Routes {
4090
4090
  name: string;
4091
4091
  /**
4092
4092
  * @deprecated Use `external_type`. */
4093
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4093
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
4094
4094
  /**
4095
4095
  * @deprecated Use `external_type_display_name`. */
4096
4096
  access_group_type_display_name: string;
4097
4097
  display_name: string;
4098
4098
  /** Brand-specific terminology for the access group type. */
4099
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4099
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
4100
4100
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4101
4101
  external_type_display_name: string;
4102
4102
  /** Date and time at which the access group was created. */
@@ -4129,13 +4129,13 @@ export interface Routes {
4129
4129
  name: string;
4130
4130
  /**
4131
4131
  * @deprecated Use `external_type`. */
4132
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4132
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
4133
4133
  /**
4134
4134
  * @deprecated Use `external_type_display_name`. */
4135
4135
  access_group_type_display_name: string;
4136
4136
  display_name: string;
4137
4137
  /** Brand-specific terminology for the access group type. */
4138
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4138
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group';
4139
4139
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4140
4140
  external_type_display_name: string;
4141
4141
  /** Date and time at which the access group was created. */
@@ -5555,7 +5555,7 @@ export interface Routes {
5555
5555
  type: 'action_attempt_expired';
5556
5556
  message: string;
5557
5557
  } | {
5558
- type: 'no_card_on_encoder';
5558
+ type: 'no_credential_on_encoder';
5559
5559
  message: string;
5560
5560
  };
5561
5561
  } | {
@@ -5759,7 +5759,7 @@ export interface Routes {
5759
5759
  type: 'action_attempt_expired';
5760
5760
  message: string;
5761
5761
  } | {
5762
- type: 'no_card_on_encoder';
5762
+ type: 'no_credential_on_encoder';
5763
5763
  message: string;
5764
5764
  } | {
5765
5765
  type: 'incompatible_card_format';
@@ -6374,7 +6374,7 @@ export interface Routes {
6374
6374
  type: 'action_attempt_expired';
6375
6375
  message: string;
6376
6376
  } | {
6377
- type: 'no_card_on_encoder';
6377
+ type: 'no_credential_on_encoder';
6378
6378
  message: string;
6379
6379
  };
6380
6380
  } | {
@@ -6578,7 +6578,7 @@ export interface Routes {
6578
6578
  type: 'action_attempt_expired';
6579
6579
  message: string;
6580
6580
  } | {
6581
- type: 'no_card_on_encoder';
6581
+ type: 'no_credential_on_encoder';
6582
6582
  message: string;
6583
6583
  } | {
6584
6584
  type: 'incompatible_card_format';
@@ -6859,6 +6859,69 @@ export interface Routes {
6859
6859
  };
6860
6860
  };
6861
6861
  };
6862
+ '/acs/encoders/simulate/next_credential_encode_will_fail': {
6863
+ route: '/acs/encoders/simulate/next_credential_encode_will_fail';
6864
+ method: 'POST';
6865
+ queryParams: {};
6866
+ jsonBody: {
6867
+ acs_encoder_id: string;
6868
+ error_code?: 'no_credential_on_encoder';
6869
+ } | {
6870
+ acs_encoder_id: string;
6871
+ error_code: 'uncategorized_error' | 'action_attempt_expired';
6872
+ acs_credential_id?: string | undefined;
6873
+ };
6874
+ commonParams: {};
6875
+ formData: {};
6876
+ jsonResponse: {};
6877
+ };
6878
+ '/acs/encoders/simulate/next_credential_encode_will_succeed': {
6879
+ route: '/acs/encoders/simulate/next_credential_encode_will_succeed';
6880
+ method: 'POST';
6881
+ queryParams: {};
6882
+ jsonBody: {
6883
+ acs_encoder_id: string;
6884
+ scenario?: 'credential_is_issued';
6885
+ };
6886
+ commonParams: {};
6887
+ formData: {};
6888
+ jsonResponse: {};
6889
+ };
6890
+ '/acs/encoders/simulate/next_credential_scan_will_fail': {
6891
+ route: '/acs/encoders/simulate/next_credential_scan_will_fail';
6892
+ method: 'POST';
6893
+ queryParams: {};
6894
+ jsonBody: {
6895
+ acs_encoder_id: string;
6896
+ error_code?: 'no_credential_on_encoder';
6897
+ } | {
6898
+ acs_encoder_id: string;
6899
+ error_code: 'uncategorized_error' | 'action_attempt_expired';
6900
+ acs_credential_id_on_seam?: string | undefined;
6901
+ };
6902
+ commonParams: {};
6903
+ formData: {};
6904
+ jsonResponse: {};
6905
+ };
6906
+ '/acs/encoders/simulate/next_credential_scan_will_succeed': {
6907
+ route: '/acs/encoders/simulate/next_credential_scan_will_succeed';
6908
+ method: 'POST';
6909
+ queryParams: {};
6910
+ jsonBody: {
6911
+ acs_encoder_id: string;
6912
+ scenario?: 'credential_exists_on_seam' | 'credential_on_encoder_needs_update';
6913
+ acs_credential_id_on_seam?: string | undefined;
6914
+ } | {
6915
+ acs_encoder_id: string;
6916
+ scenario: 'credential_does_not_exist_on_seam';
6917
+ } | {
6918
+ acs_encoder_id: string;
6919
+ scenario: 'credential_on_encoder_is_empty';
6920
+ };
6921
+ commonParams: {};
6922
+ formData: {};
6923
+ jsonResponse: {};
6924
+ };
6862
6925
  '/acs/entrances/get': {
6863
6926
  route: '/acs/entrances/get';
6864
6927
  method: 'GET' | 'POST';
@@ -8485,7 +8548,7 @@ export interface Routes {
8485
8548
  type: 'action_attempt_expired';
8486
8549
  message: string;
8487
8550
  } | {
8488
- type: 'no_card_on_encoder';
8551
+ type: 'no_credential_on_encoder';
8489
8552
  message: string;
8490
8553
  };
8491
8554
  } | {
@@ -8689,7 +8752,7 @@ export interface Routes {
8689
8752
  type: 'action_attempt_expired';
8690
8753
  message: string;
8691
8754
  } | {
8692
- type: 'no_card_on_encoder';
8755
+ type: 'no_credential_on_encoder';
8693
8756
  message: string;
8694
8757
  } | {
8695
8758
  type: 'incompatible_card_format';
@@ -9261,7 +9324,7 @@ export interface Routes {
9261
9324
  type: 'action_attempt_expired';
9262
9325
  message: string;
9263
9326
  } | {
9264
- type: 'no_card_on_encoder';
9327
+ type: 'no_credential_on_encoder';
9265
9328
  message: string;
9266
9329
  };
9267
9330
  } | {
@@ -9465,7 +9528,7 @@ export interface Routes {
9465
9528
  type: 'action_attempt_expired';
9466
9529
  message: string;
9467
9530
  } | {
9468
- type: 'no_card_on_encoder';
9531
+ type: 'no_credential_on_encoder';
9469
9532
  message: string;
9470
9533
  } | {
9471
9534
  type: 'incompatible_card_format';
@@ -16293,7 +16356,7 @@ export interface Routes {
16293
16356
  type: 'action_attempt_expired';
16294
16357
  message: string;
16295
16358
  } | {
16296
- type: 'no_card_on_encoder';
16359
+ type: 'no_credential_on_encoder';
16297
16360
  message: string;
16298
16361
  };
16299
16362
  } | {
@@ -16497,7 +16560,7 @@ export interface Routes {
16497
16560
  type: 'action_attempt_expired';
16498
16561
  message: string;
16499
16562
  } | {
16500
- type: 'no_card_on_encoder';
16563
+ type: 'no_credential_on_encoder';
16501
16564
  message: string;
16502
16565
  } | {
16503
16566
  type: 'incompatible_card_format';
@@ -17070,7 +17133,7 @@ export interface Routes {
17070
17133
  type: 'action_attempt_expired';
17071
17134
  message: string;
17072
17135
  } | {
17073
- type: 'no_card_on_encoder';
17136
+ type: 'no_credential_on_encoder';
17074
17137
  message: string;
17075
17138
  };
17076
17139
  } | {
@@ -17274,7 +17337,7 @@ export interface Routes {
17274
17337
  type: 'action_attempt_expired';
17275
17338
  message: string;
17276
17339
  } | {
17277
- type: 'no_card_on_encoder';
17340
+ type: 'no_credential_on_encoder';
17278
17341
  message: string;
17279
17342
  } | {
17280
17343
  type: 'incompatible_card_format';
@@ -18957,7 +19020,7 @@ export interface Routes {
18957
19020
  type: 'action_attempt_expired';
18958
19021
  message: string;
18959
19022
  } | {
18960
- type: 'no_card_on_encoder';
19023
+ type: 'no_credential_on_encoder';
18961
19024
  message: string;
18962
19025
  };
18963
19026
  } | {
@@ -19161,7 +19224,7 @@ export interface Routes {
19161
19224
  type: 'action_attempt_expired';
19162
19225
  message: string;
19163
19226
  } | {
19164
- type: 'no_card_on_encoder';
19227
+ type: 'no_credential_on_encoder';
19165
19228
  message: string;
19166
19229
  } | {
19167
19230
  type: 'incompatible_card_format';
@@ -19744,7 +19807,7 @@ export interface Routes {
19744
19807
  type: 'action_attempt_expired';
19745
19808
  message: string;
19746
19809
  } | {
19747
- type: 'no_card_on_encoder';
19810
+ type: 'no_credential_on_encoder';
19748
19811
  message: string;
19749
19812
  };
19750
19813
  } | {
@@ -19948,7 +20011,7 @@ export interface Routes {
19948
20011
  type: 'action_attempt_expired';
19949
20012
  message: string;
19950
20013
  } | {
19951
- type: 'no_card_on_encoder';
20014
+ type: 'no_credential_on_encoder';
19952
20015
  message: string;
19953
20016
  } | {
19954
20017
  type: 'incompatible_card_format';
@@ -20570,7 +20633,7 @@ export interface Routes {
20570
20633
  type: 'action_attempt_expired';
20571
20634
  message: string;
20572
20635
  } | {
20573
- type: 'no_card_on_encoder';
20636
+ type: 'no_credential_on_encoder';
20574
20637
  message: string;
20575
20638
  };
20576
20639
  } | {
@@ -20774,7 +20837,7 @@ export interface Routes {
20774
20837
  type: 'action_attempt_expired';
20775
20838
  message: string;
20776
20839
  } | {
20777
- type: 'no_card_on_encoder';
20840
+ type: 'no_credential_on_encoder';
20778
20841
  message: string;
20779
20842
  } | {
20780
20843
  type: 'incompatible_card_format';
@@ -21531,7 +21594,7 @@ export interface Routes {
21531
21594
  type: 'action_attempt_expired';
21532
21595
  message: string;
21533
21596
  } | {
21534
- type: 'no_card_on_encoder';
21597
+ type: 'no_credential_on_encoder';
21535
21598
  message: string;
21536
21599
  };
21537
21600
  } | {
@@ -21735,7 +21798,7 @@ export interface Routes {
21735
21798
  type: 'action_attempt_expired';
21736
21799
  message: string;
21737
21800
  } | {
21738
- type: 'no_card_on_encoder';
21801
+ type: 'no_credential_on_encoder';
21739
21802
  message: string;
21740
21803
  } | {
21741
21804
  type: 'incompatible_card_format';
@@ -22314,7 +22377,7 @@ export interface Routes {
22314
22377
  type: 'action_attempt_expired';
22315
22378
  message: string;
22316
22379
  } | {
22317
- type: 'no_card_on_encoder';
22380
+ type: 'no_credential_on_encoder';
22318
22381
  message: string;
22319
22382
  };
22320
22383
  } | {
@@ -22518,7 +22581,7 @@ export interface Routes {
22518
22581
  type: 'action_attempt_expired';
22519
22582
  message: string;
22520
22583
  } | {
22521
- type: 'no_card_on_encoder';
22584
+ type: 'no_credential_on_encoder';
22522
22585
  message: string;
22523
22586
  } | {
22524
22587
  type: 'incompatible_card_format';
@@ -23674,7 +23737,7 @@ export interface Routes {
23674
23737
  type: 'action_attempt_expired';
23675
23738
  message: string;
23676
23739
  } | {
23677
- type: 'no_card_on_encoder';
23740
+ type: 'no_credential_on_encoder';
23678
23741
  message: string;
23679
23742
  };
23680
23743
  } | {
@@ -23878,7 +23941,7 @@ export interface Routes {
23878
23941
  type: 'action_attempt_expired';
23879
23942
  message: string;
23880
23943
  } | {
23881
- type: 'no_card_on_encoder';
23944
+ type: 'no_credential_on_encoder';
23882
23945
  message: string;
23883
23946
  } | {
23884
23947
  type: 'incompatible_card_format';
@@ -24461,7 +24524,7 @@ export interface Routes {
24461
24524
  type: 'action_attempt_expired';
24462
24525
  message: string;
24463
24526
  } | {
24464
- type: 'no_card_on_encoder';
24527
+ type: 'no_credential_on_encoder';
24465
24528
  message: string;
24466
24529
  };
24467
24530
  } | {
@@ -24665,7 +24728,7 @@ export interface Routes {
24665
24728
  type: 'action_attempt_expired';
24666
24729
  message: string;
24667
24730
  } | {
24668
- type: 'no_card_on_encoder';
24731
+ type: 'no_credential_on_encoder';
24669
24732
  message: string;
24670
24733
  } | {
24671
24734
  type: 'incompatible_card_format';
@@ -26311,7 +26374,7 @@ export interface Routes {
26311
26374
  type: 'action_attempt_expired';
26312
26375
  message: string;
26313
26376
  } | {
26314
- type: 'no_card_on_encoder';
26377
+ type: 'no_credential_on_encoder';
26315
26378
  message: string;
26316
26379
  };
26317
26380
  } | {
@@ -26515,7 +26578,7 @@ export interface Routes {
26515
26578
  type: 'action_attempt_expired';
26516
26579
  message: string;
26517
26580
  } | {
26518
- type: 'no_card_on_encoder';
26581
+ type: 'no_credential_on_encoder';
26519
26582
  message: string;
26520
26583
  } | {
26521
26584
  type: 'incompatible_card_format';
@@ -27265,7 +27328,7 @@ export interface Routes {
27265
27328
  type: 'action_attempt_expired';
27266
27329
  message: string;
27267
27330
  } | {
27268
- type: 'no_card_on_encoder';
27331
+ type: 'no_credential_on_encoder';
27269
27332
  message: string;
27270
27333
  };
27271
27334
  } | {
@@ -27469,7 +27532,7 @@ export interface Routes {
27469
27532
  type: 'action_attempt_expired';
27470
27533
  message: string;
27471
27534
  } | {
27472
- type: 'no_card_on_encoder';
27535
+ type: 'no_credential_on_encoder';
27473
27536
  message: string;
27474
27537
  } | {
27475
27538
  type: 'incompatible_card_format';
@@ -28071,7 +28134,7 @@ export interface Routes {
28071
28134
  type: 'action_attempt_expired';
28072
28135
  message: string;
28073
28136
  } | {
28074
- type: 'no_card_on_encoder';
28137
+ type: 'no_credential_on_encoder';
28075
28138
  message: string;
28076
28139
  };
28077
28140
  } | {
@@ -28275,7 +28338,7 @@ export interface Routes {
28275
28338
  type: 'action_attempt_expired';
28276
28339
  message: string;
28277
28340
  } | {
28278
- type: 'no_card_on_encoder';
28341
+ type: 'no_credential_on_encoder';
28279
28342
  message: string;
28280
28343
  } | {
28281
28344
  type: 'incompatible_card_format';
@@ -30589,7 +30652,7 @@ export interface Routes {
30589
30652
  type: 'action_attempt_expired';
30590
30653
  message: string;
30591
30654
  } | {
30592
- type: 'no_card_on_encoder';
30655
+ type: 'no_credential_on_encoder';
30593
30656
  message: string;
30594
30657
  };
30595
30658
  } | {
@@ -30793,7 +30856,7 @@ export interface Routes {
30793
30856
  type: 'action_attempt_expired';
30794
30857
  message: string;
30795
30858
  } | {
30796
- type: 'no_card_on_encoder';
30859
+ type: 'no_credential_on_encoder';
30797
30860
  message: string;
30798
30861
  } | {
30799
30862
  type: 'incompatible_card_format';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.313.0",
3
+ "version": "1.314.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -6,6 +6,7 @@ export const acs_access_group_external_type = z.enum([
6
6
  'pti_access_level',
7
7
  'salto_ks_access_group',
8
8
  'brivo_group',
9
+ 'salto_space_group',
9
10
  ])
10
11
 
11
12
  export type AcsAccessGroupExternalType = z.infer<
@@ -13,8 +13,8 @@ import {
13
13
 
14
14
  const action_type = z.literal('ENCODE_CREDENTIAL')
15
15
 
16
- const no_card_on_encoder_error = z.object({
17
- type: z.literal('no_card_on_encoder'),
16
+ const no_credential_on_encoder_error = z.object({
17
+ type: z.literal('no_credential_on_encoder'),
18
18
  message: z.string(),
19
19
  })
20
20
 
@@ -25,7 +25,7 @@ const incompatible_card_format_error = z.object({
25
25
 
26
26
  const error = z.union([
27
27
  ...common_action_attempt_errors,
28
- no_card_on_encoder_error,
28
+ no_credential_on_encoder_error,
29
29
  incompatible_card_format_error,
30
30
  ])
31
31
 
@@ -14,14 +14,14 @@ import {
14
14
 
15
15
  const action_type = z.literal('SCAN_CREDENTIAL')
16
16
 
17
- const no_card_on_encoder_error = z.object({
18
- type: z.literal('no_card_on_encoder'),
17
+ const no_credential_on_encoder_error = z.object({
18
+ type: z.literal('no_credential_on_encoder'),
19
19
  message: z.string(),
20
20
  })
21
21
 
22
22
  const error = z.union([
23
23
  ...common_action_attempt_errors,
24
- no_card_on_encoder_error,
24
+ no_credential_on_encoder_error,
25
25
  ])
26
26
 
27
27
  const warning = z.object({