@seamapi/types 1.384.0 → 1.386.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 (46) hide show
  1. package/dist/connect.cjs +629 -150
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +4211 -445
  4. package/lib/seam/connect/models/access-grants/access-grant.d.ts +8 -5
  5. package/lib/seam/connect/models/access-grants/access-grant.js +3 -0
  6. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  7. package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -3
  8. package/lib/seam/connect/models/access-grants/requested-access-method.js +2 -2
  9. package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +156 -0
  11. package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -0
  12. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  13. package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.d.ts +80 -0
  14. package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js +28 -0
  15. package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js.map +1 -0
  16. package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.d.ts +80 -0
  17. package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js +28 -0
  18. package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js.map +1 -0
  19. package/lib/seam/connect/models/colors.d.ts +2 -0
  20. package/lib/seam/connect/models/colors.js +8 -0
  21. package/lib/seam/connect/models/colors.js.map +1 -0
  22. package/lib/seam/connect/models/events/access-grants.d.ts +277 -0
  23. package/lib/seam/connect/models/events/access-grants.js +60 -0
  24. package/lib/seam/connect/models/events/access-grants.js.map +1 -0
  25. package/lib/seam/connect/models/events/access-methods.d.ts +146 -0
  26. package/lib/seam/connect/models/events/access-methods.js +35 -0
  27. package/lib/seam/connect/models/events/access-methods.js.map +1 -0
  28. package/lib/seam/connect/models/workspaces/workspace.d.ts +33 -0
  29. package/lib/seam/connect/models/workspaces/workspace.js +8 -0
  30. package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
  31. package/lib/seam/connect/openapi.d.ts +523 -225
  32. package/lib/seam/connect/openapi.js +592 -171
  33. package/lib/seam/connect/openapi.js.map +1 -1
  34. package/lib/seam/connect/route-types.d.ts +3477 -198
  35. package/package.json +2 -2
  36. package/src/lib/seam/connect/models/access-grants/access-grant.ts +5 -0
  37. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +4 -2
  38. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -0
  39. package/src/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.ts +39 -0
  40. package/src/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.ts +37 -0
  41. package/src/lib/seam/connect/models/colors.ts +9 -0
  42. package/src/lib/seam/connect/models/events/access-grants.ts +92 -0
  43. package/src/lib/seam/connect/models/events/access-methods.ts +51 -0
  44. package/src/lib/seam/connect/models/workspaces/workspace.ts +9 -0
  45. package/src/lib/seam/connect/openapi.ts +615 -175
  46. package/src/lib/seam/connect/route-types.ts +3793 -36
@@ -933,6 +933,68 @@ export interface Routes {
933
933
  message: string
934
934
  }
935
935
  }
936
+ | {
937
+ /** ID of the action attempt. */
938
+ action_attempt_id: string
939
+ status: 'pending'
940
+ /** Result of the action attempt. Null for pending action attempts. */
941
+ result: null
942
+ /** Errors associated with the action attempt. Null for pending action attempts. */
943
+ error: null
944
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
945
+ }
946
+ | {
947
+ /** ID of the action attempt. */
948
+ action_attempt_id: string
949
+ status: 'success'
950
+ /** Errors associated with the action attempt. Null for successful action attempts. */
951
+ error: null
952
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
953
+ result: {}
954
+ }
955
+ | {
956
+ /** ID of the action attempt. */
957
+ action_attempt_id: string
958
+ status: 'error'
959
+ /** Result of the action attempt. Null for failed action attempts. */
960
+ result: null
961
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
962
+ error: {
963
+ type: string
964
+ message: string
965
+ }
966
+ }
967
+ | {
968
+ /** ID of the action attempt. */
969
+ action_attempt_id: string
970
+ status: 'pending'
971
+ /** Result of the action attempt. Null for pending action attempts. */
972
+ result: null
973
+ /** Errors associated with the action attempt. Null for pending action attempts. */
974
+ error: null
975
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
976
+ }
977
+ | {
978
+ /** ID of the action attempt. */
979
+ action_attempt_id: string
980
+ status: 'success'
981
+ /** Errors associated with the action attempt. Null for successful action attempts. */
982
+ error: null
983
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
984
+ result: {}
985
+ }
986
+ | {
987
+ /** ID of the action attempt. */
988
+ action_attempt_id: string
989
+ status: 'error'
990
+ /** Result of the action attempt. Null for failed action attempts. */
991
+ result: null
992
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
993
+ error: {
994
+ type: string
995
+ message: string
996
+ }
997
+ }
936
998
  | {
937
999
  /** ID of the action attempt. */
938
1000
  action_attempt_id: string
@@ -3102,6 +3164,68 @@ export interface Routes {
3102
3164
  message: string
3103
3165
  }
3104
3166
  }
3167
+ | {
3168
+ /** ID of the action attempt. */
3169
+ action_attempt_id: string
3170
+ status: 'pending'
3171
+ /** Result of the action attempt. Null for pending action attempts. */
3172
+ result: null
3173
+ /** Errors associated with the action attempt. Null for pending action attempts. */
3174
+ error: null
3175
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
3176
+ }
3177
+ | {
3178
+ /** ID of the action attempt. */
3179
+ action_attempt_id: string
3180
+ status: 'success'
3181
+ /** Errors associated with the action attempt. Null for successful action attempts. */
3182
+ error: null
3183
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
3184
+ result: {}
3185
+ }
3186
+ | {
3187
+ /** ID of the action attempt. */
3188
+ action_attempt_id: string
3189
+ status: 'error'
3190
+ /** Result of the action attempt. Null for failed action attempts. */
3191
+ result: null
3192
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
3193
+ error: {
3194
+ type: string
3195
+ message: string
3196
+ }
3197
+ }
3198
+ | {
3199
+ /** ID of the action attempt. */
3200
+ action_attempt_id: string
3201
+ status: 'pending'
3202
+ /** Result of the action attempt. Null for pending action attempts. */
3203
+ result: null
3204
+ /** Errors associated with the action attempt. Null for pending action attempts. */
3205
+ error: null
3206
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
3207
+ }
3208
+ | {
3209
+ /** ID of the action attempt. */
3210
+ action_attempt_id: string
3211
+ status: 'success'
3212
+ /** Errors associated with the action attempt. Null for successful action attempts. */
3213
+ error: null
3214
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
3215
+ result: {}
3216
+ }
3217
+ | {
3218
+ /** ID of the action attempt. */
3219
+ action_attempt_id: string
3220
+ status: 'error'
3221
+ /** Result of the action attempt. Null for failed action attempts. */
3222
+ result: null
3223
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
3224
+ error: {
3225
+ type: string
3226
+ message: string
3227
+ }
3228
+ }
3105
3229
  | {
3106
3230
  /** ID of the action attempt. */
3107
3231
  action_attempt_id: string
@@ -6810,6 +6934,68 @@ export interface Routes {
6810
6934
  message: string
6811
6935
  }
6812
6936
  }
6937
+ | {
6938
+ /** ID of the action attempt. */
6939
+ action_attempt_id: string
6940
+ status: 'pending'
6941
+ /** Result of the action attempt. Null for pending action attempts. */
6942
+ result: null
6943
+ /** Errors associated with the action attempt. Null for pending action attempts. */
6944
+ error: null
6945
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
6946
+ }
6947
+ | {
6948
+ /** ID of the action attempt. */
6949
+ action_attempt_id: string
6950
+ status: 'success'
6951
+ /** Errors associated with the action attempt. Null for successful action attempts. */
6952
+ error: null
6953
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
6954
+ result: {}
6955
+ }
6956
+ | {
6957
+ /** ID of the action attempt. */
6958
+ action_attempt_id: string
6959
+ status: 'error'
6960
+ /** Result of the action attempt. Null for failed action attempts. */
6961
+ result: null
6962
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
6963
+ error: {
6964
+ type: string
6965
+ message: string
6966
+ }
6967
+ }
6968
+ | {
6969
+ /** ID of the action attempt. */
6970
+ action_attempt_id: string
6971
+ status: 'pending'
6972
+ /** Result of the action attempt. Null for pending action attempts. */
6973
+ result: null
6974
+ /** Errors associated with the action attempt. Null for pending action attempts. */
6975
+ error: null
6976
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
6977
+ }
6978
+ | {
6979
+ /** ID of the action attempt. */
6980
+ action_attempt_id: string
6981
+ status: 'success'
6982
+ /** Errors associated with the action attempt. Null for successful action attempts. */
6983
+ error: null
6984
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
6985
+ result: {}
6986
+ }
6987
+ | {
6988
+ /** ID of the action attempt. */
6989
+ action_attempt_id: string
6990
+ status: 'error'
6991
+ /** Result of the action attempt. Null for failed action attempts. */
6992
+ result: null
6993
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
6994
+ error: {
6995
+ type: string
6996
+ message: string
6997
+ }
6998
+ }
6813
6999
  | {
6814
7000
  /** ID of the action attempt. */
6815
7001
  action_attempt_id: string
@@ -8983,6 +9169,68 @@ export interface Routes {
8983
9169
  message: string
8984
9170
  }
8985
9171
  }
9172
+ | {
9173
+ /** ID of the action attempt. */
9174
+ action_attempt_id: string
9175
+ status: 'pending'
9176
+ /** Result of the action attempt. Null for pending action attempts. */
9177
+ result: null
9178
+ /** Errors associated with the action attempt. Null for pending action attempts. */
9179
+ error: null
9180
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
9181
+ }
9182
+ | {
9183
+ /** ID of the action attempt. */
9184
+ action_attempt_id: string
9185
+ status: 'success'
9186
+ /** Errors associated with the action attempt. Null for successful action attempts. */
9187
+ error: null
9188
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
9189
+ result: {}
9190
+ }
9191
+ | {
9192
+ /** ID of the action attempt. */
9193
+ action_attempt_id: string
9194
+ status: 'error'
9195
+ /** Result of the action attempt. Null for failed action attempts. */
9196
+ result: null
9197
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
9198
+ error: {
9199
+ type: string
9200
+ message: string
9201
+ }
9202
+ }
9203
+ | {
9204
+ /** ID of the action attempt. */
9205
+ action_attempt_id: string
9206
+ status: 'pending'
9207
+ /** Result of the action attempt. Null for pending action attempts. */
9208
+ result: null
9209
+ /** Errors associated with the action attempt. Null for pending action attempts. */
9210
+ error: null
9211
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
9212
+ }
9213
+ | {
9214
+ /** ID of the action attempt. */
9215
+ action_attempt_id: string
9216
+ status: 'success'
9217
+ /** Errors associated with the action attempt. Null for successful action attempts. */
9218
+ error: null
9219
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
9220
+ result: {}
9221
+ }
9222
+ | {
9223
+ /** ID of the action attempt. */
9224
+ action_attempt_id: string
9225
+ status: 'error'
9226
+ /** Result of the action attempt. Null for failed action attempts. */
9227
+ result: null
9228
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
9229
+ error: {
9230
+ type: string
9231
+ message: string
9232
+ }
9233
+ }
8986
9234
  | {
8987
9235
  /** ID of the action attempt. */
8988
9236
  action_attempt_id: string
@@ -12343,6 +12591,68 @@ export interface Routes {
12343
12591
  message: string
12344
12592
  }
12345
12593
  }
12594
+ | {
12595
+ /** ID of the action attempt. */
12596
+ action_attempt_id: string
12597
+ status: 'pending'
12598
+ /** Result of the action attempt. Null for pending action attempts. */
12599
+ result: null
12600
+ /** Errors associated with the action attempt. Null for pending action attempts. */
12601
+ error: null
12602
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
12603
+ }
12604
+ | {
12605
+ /** ID of the action attempt. */
12606
+ action_attempt_id: string
12607
+ status: 'success'
12608
+ /** Errors associated with the action attempt. Null for successful action attempts. */
12609
+ error: null
12610
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
12611
+ result: {}
12612
+ }
12613
+ | {
12614
+ /** ID of the action attempt. */
12615
+ action_attempt_id: string
12616
+ status: 'error'
12617
+ /** Result of the action attempt. Null for failed action attempts. */
12618
+ result: null
12619
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
12620
+ error: {
12621
+ type: string
12622
+ message: string
12623
+ }
12624
+ }
12625
+ | {
12626
+ /** ID of the action attempt. */
12627
+ action_attempt_id: string
12628
+ status: 'pending'
12629
+ /** Result of the action attempt. Null for pending action attempts. */
12630
+ result: null
12631
+ /** Errors associated with the action attempt. Null for pending action attempts. */
12632
+ error: null
12633
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
12634
+ }
12635
+ | {
12636
+ /** ID of the action attempt. */
12637
+ action_attempt_id: string
12638
+ status: 'success'
12639
+ /** Errors associated with the action attempt. Null for successful action attempts. */
12640
+ error: null
12641
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
12642
+ result: {}
12643
+ }
12644
+ | {
12645
+ /** ID of the action attempt. */
12646
+ action_attempt_id: string
12647
+ status: 'error'
12648
+ /** Result of the action attempt. Null for failed action attempts. */
12649
+ result: null
12650
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
12651
+ error: {
12652
+ type: string
12653
+ message: string
12654
+ }
12655
+ }
12346
12656
  | {
12347
12657
  /** ID of the action attempt. */
12348
12658
  action_attempt_id: string
@@ -13571,6 +13881,68 @@ export interface Routes {
13571
13881
  message: string
13572
13882
  }
13573
13883
  }
13884
+ | {
13885
+ /** ID of the action attempt. */
13886
+ action_attempt_id: string
13887
+ status: 'pending'
13888
+ /** Result of the action attempt. Null for pending action attempts. */
13889
+ result: null
13890
+ /** Errors associated with the action attempt. Null for pending action attempts. */
13891
+ error: null
13892
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
13893
+ }
13894
+ | {
13895
+ /** ID of the action attempt. */
13896
+ action_attempt_id: string
13897
+ status: 'success'
13898
+ /** Errors associated with the action attempt. Null for successful action attempts. */
13899
+ error: null
13900
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
13901
+ result: {}
13902
+ }
13903
+ | {
13904
+ /** ID of the action attempt. */
13905
+ action_attempt_id: string
13906
+ status: 'error'
13907
+ /** Result of the action attempt. Null for failed action attempts. */
13908
+ result: null
13909
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
13910
+ error: {
13911
+ type: string
13912
+ message: string
13913
+ }
13914
+ }
13915
+ | {
13916
+ /** ID of the action attempt. */
13917
+ action_attempt_id: string
13918
+ status: 'pending'
13919
+ /** Result of the action attempt. Null for pending action attempts. */
13920
+ result: null
13921
+ /** Errors associated with the action attempt. Null for pending action attempts. */
13922
+ error: null
13923
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
13924
+ }
13925
+ | {
13926
+ /** ID of the action attempt. */
13927
+ action_attempt_id: string
13928
+ status: 'success'
13929
+ /** Errors associated with the action attempt. Null for successful action attempts. */
13930
+ error: null
13931
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
13932
+ result: {}
13933
+ }
13934
+ | {
13935
+ /** ID of the action attempt. */
13936
+ action_attempt_id: string
13937
+ status: 'error'
13938
+ /** Result of the action attempt. Null for failed action attempts. */
13939
+ result: null
13940
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
13941
+ error: {
13942
+ type: string
13943
+ message: string
13944
+ }
13945
+ }
13574
13946
  | {
13575
13947
  /** ID of the action attempt. */
13576
13948
  action_attempt_id: string
@@ -16984,6 +17356,68 @@ export interface Routes {
16984
17356
  message: string
16985
17357
  }
16986
17358
  }
17359
+ | {
17360
+ /** ID of the action attempt. */
17361
+ action_attempt_id: string
17362
+ status: 'pending'
17363
+ /** Result of the action attempt. Null for pending action attempts. */
17364
+ result: null
17365
+ /** Errors associated with the action attempt. Null for pending action attempts. */
17366
+ error: null
17367
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
17368
+ }
17369
+ | {
17370
+ /** ID of the action attempt. */
17371
+ action_attempt_id: string
17372
+ status: 'success'
17373
+ /** Errors associated with the action attempt. Null for successful action attempts. */
17374
+ error: null
17375
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
17376
+ result: {}
17377
+ }
17378
+ | {
17379
+ /** ID of the action attempt. */
17380
+ action_attempt_id: string
17381
+ status: 'error'
17382
+ /** Result of the action attempt. Null for failed action attempts. */
17383
+ result: null
17384
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
17385
+ error: {
17386
+ type: string
17387
+ message: string
17388
+ }
17389
+ }
17390
+ | {
17391
+ /** ID of the action attempt. */
17392
+ action_attempt_id: string
17393
+ status: 'pending'
17394
+ /** Result of the action attempt. Null for pending action attempts. */
17395
+ result: null
17396
+ /** Errors associated with the action attempt. Null for pending action attempts. */
17397
+ error: null
17398
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
17399
+ }
17400
+ | {
17401
+ /** ID of the action attempt. */
17402
+ action_attempt_id: string
17403
+ status: 'success'
17404
+ /** Errors associated with the action attempt. Null for successful action attempts. */
17405
+ error: null
17406
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
17407
+ result: {}
17408
+ }
17409
+ | {
17410
+ /** ID of the action attempt. */
17411
+ action_attempt_id: string
17412
+ status: 'error'
17413
+ /** Result of the action attempt. Null for failed action attempts. */
17414
+ result: null
17415
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
17416
+ error: {
17417
+ type: string
17418
+ message: string
17419
+ }
17420
+ }
16987
17421
  | {
16988
17422
  /** ID of the action attempt. */
16989
17423
  action_attempt_id: string
@@ -18113,6 +18547,68 @@ export interface Routes {
18113
18547
  message: string
18114
18548
  }
18115
18549
  }
18550
+ | {
18551
+ /** ID of the action attempt. */
18552
+ action_attempt_id: string
18553
+ status: 'pending'
18554
+ /** Result of the action attempt. Null for pending action attempts. */
18555
+ result: null
18556
+ /** Errors associated with the action attempt. Null for pending action attempts. */
18557
+ error: null
18558
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
18559
+ }
18560
+ | {
18561
+ /** ID of the action attempt. */
18562
+ action_attempt_id: string
18563
+ status: 'success'
18564
+ /** Errors associated with the action attempt. Null for successful action attempts. */
18565
+ error: null
18566
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
18567
+ result: {}
18568
+ }
18569
+ | {
18570
+ /** ID of the action attempt. */
18571
+ action_attempt_id: string
18572
+ status: 'error'
18573
+ /** Result of the action attempt. Null for failed action attempts. */
18574
+ result: null
18575
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
18576
+ error: {
18577
+ type: string
18578
+ message: string
18579
+ }
18580
+ }
18581
+ | {
18582
+ /** ID of the action attempt. */
18583
+ action_attempt_id: string
18584
+ status: 'pending'
18585
+ /** Result of the action attempt. Null for pending action attempts. */
18586
+ result: null
18587
+ /** Errors associated with the action attempt. Null for pending action attempts. */
18588
+ error: null
18589
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
18590
+ }
18591
+ | {
18592
+ /** ID of the action attempt. */
18593
+ action_attempt_id: string
18594
+ status: 'success'
18595
+ /** Errors associated with the action attempt. Null for successful action attempts. */
18596
+ error: null
18597
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
18598
+ result: {}
18599
+ }
18600
+ | {
18601
+ /** ID of the action attempt. */
18602
+ action_attempt_id: string
18603
+ status: 'error'
18604
+ /** Result of the action attempt. Null for failed action attempts. */
18605
+ result: null
18606
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
18607
+ error: {
18608
+ type: string
18609
+ message: string
18610
+ }
18611
+ }
18116
18612
  | {
18117
18613
  /** ID of the action attempt. */
18118
18614
  action_attempt_id: string
@@ -21240,30 +21736,6 @@ export interface Routes {
21240
21736
  }>
21241
21737
  }
21242
21738
  }
21243
- '/devices/simulate/access_code_lock': {
21244
- route: '/devices/simulate/access_code_lock'
21245
- method: 'POST'
21246
- queryParams: {}
21247
- jsonBody: {
21248
- device_id: string
21249
- access_code_id: string
21250
- }
21251
- commonParams: {}
21252
- formData: {}
21253
- jsonResponse: {}
21254
- }
21255
- '/devices/simulate/access_code_unlock': {
21256
- route: '/devices/simulate/access_code_unlock'
21257
- method: 'POST'
21258
- queryParams: {}
21259
- jsonBody: {
21260
- device_id: string
21261
- access_code_id: string
21262
- }
21263
- commonParams: {}
21264
- formData: {}
21265
- jsonResponse: {}
21266
- }
21267
21739
  '/devices/simulate/connect': {
21268
21740
  route: '/devices/simulate/connect'
21269
21741
  method: 'POST'
@@ -29925,6 +30397,68 @@ export interface Routes {
29925
30397
  message: string
29926
30398
  }
29927
30399
  }
30400
+ | {
30401
+ /** ID of the action attempt. */
30402
+ action_attempt_id: string
30403
+ status: 'pending'
30404
+ /** Result of the action attempt. Null for pending action attempts. */
30405
+ result: null
30406
+ /** Errors associated with the action attempt. Null for pending action attempts. */
30407
+ error: null
30408
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
30409
+ }
30410
+ | {
30411
+ /** ID of the action attempt. */
30412
+ action_attempt_id: string
30413
+ status: 'success'
30414
+ /** Errors associated with the action attempt. Null for successful action attempts. */
30415
+ error: null
30416
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
30417
+ result: {}
30418
+ }
30419
+ | {
30420
+ /** ID of the action attempt. */
30421
+ action_attempt_id: string
30422
+ status: 'error'
30423
+ /** Result of the action attempt. Null for failed action attempts. */
30424
+ result: null
30425
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
30426
+ error: {
30427
+ type: string
30428
+ message: string
30429
+ }
30430
+ }
30431
+ | {
30432
+ /** ID of the action attempt. */
30433
+ action_attempt_id: string
30434
+ status: 'pending'
30435
+ /** Result of the action attempt. Null for pending action attempts. */
30436
+ result: null
30437
+ /** Errors associated with the action attempt. Null for pending action attempts. */
30438
+ error: null
30439
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
30440
+ }
30441
+ | {
30442
+ /** ID of the action attempt. */
30443
+ action_attempt_id: string
30444
+ status: 'success'
30445
+ /** Errors associated with the action attempt. Null for successful action attempts. */
30446
+ error: null
30447
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
30448
+ result: {}
30449
+ }
30450
+ | {
30451
+ /** ID of the action attempt. */
30452
+ action_attempt_id: string
30453
+ status: 'error'
30454
+ /** Result of the action attempt. Null for failed action attempts. */
30455
+ result: null
30456
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
30457
+ error: {
30458
+ type: string
30459
+ message: string
30460
+ }
30461
+ }
29928
30462
  | {
29929
30463
  /** ID of the action attempt. */
29930
30464
  action_attempt_id: string
@@ -30152,13 +30686,13 @@ export interface Routes {
30152
30686
  }
30153
30687
  }
30154
30688
  }
30155
- '/locks/unlock_door': {
30156
- route: '/locks/unlock_door'
30689
+ '/locks/simulate/keypad_code_entry': {
30690
+ route: '/locks/simulate/keypad_code_entry'
30157
30691
  method: 'POST'
30158
30692
  queryParams: {}
30159
30693
  jsonBody: {
30160
30694
  device_id: string
30161
- sync?: boolean
30695
+ code: string
30162
30696
  }
30163
30697
  commonParams: {}
30164
30698
  formData: {}
@@ -31056,6 +31590,2453 @@ export interface Routes {
31056
31590
  message: string
31057
31591
  }
31058
31592
  }
31593
+ | {
31594
+ /** ID of the action attempt. */
31595
+ action_attempt_id: string
31596
+ status: 'pending'
31597
+ /** Result of the action attempt. Null for pending action attempts. */
31598
+ result: null
31599
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31600
+ error: null
31601
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
31602
+ }
31603
+ | {
31604
+ /** ID of the action attempt. */
31605
+ action_attempt_id: string
31606
+ status: 'success'
31607
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31608
+ error: null
31609
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
31610
+ result: {}
31611
+ }
31612
+ | {
31613
+ /** ID of the action attempt. */
31614
+ action_attempt_id: string
31615
+ status: 'error'
31616
+ /** Result of the action attempt. Null for failed action attempts. */
31617
+ result: null
31618
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
31619
+ error: {
31620
+ type: string
31621
+ message: string
31622
+ }
31623
+ }
31624
+ | {
31625
+ /** ID of the action attempt. */
31626
+ action_attempt_id: string
31627
+ status: 'pending'
31628
+ /** Result of the action attempt. Null for pending action attempts. */
31629
+ result: null
31630
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31631
+ error: null
31632
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
31633
+ }
31634
+ | {
31635
+ /** ID of the action attempt. */
31636
+ action_attempt_id: string
31637
+ status: 'success'
31638
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31639
+ error: null
31640
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
31641
+ result: {}
31642
+ }
31643
+ | {
31644
+ /** ID of the action attempt. */
31645
+ action_attempt_id: string
31646
+ status: 'error'
31647
+ /** Result of the action attempt. Null for failed action attempts. */
31648
+ result: null
31649
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
31650
+ error: {
31651
+ type: string
31652
+ message: string
31653
+ }
31654
+ }
31655
+ | {
31656
+ /** ID of the action attempt. */
31657
+ action_attempt_id: string
31658
+ status: 'pending'
31659
+ /** Result of the action attempt. Null for pending action attempts. */
31660
+ result: null
31661
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31662
+ error: null
31663
+ action_type: 'SYNC_ACCESS_CODES'
31664
+ }
31665
+ | {
31666
+ /** ID of the action attempt. */
31667
+ action_attempt_id: string
31668
+ status: 'success'
31669
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31670
+ error: null
31671
+ action_type: 'SYNC_ACCESS_CODES'
31672
+ result: {}
31673
+ }
31674
+ | {
31675
+ /** ID of the action attempt. */
31676
+ action_attempt_id: string
31677
+ status: 'error'
31678
+ /** Result of the action attempt. Null for failed action attempts. */
31679
+ result: null
31680
+ action_type: 'SYNC_ACCESS_CODES'
31681
+ error: {
31682
+ type: string
31683
+ message: string
31684
+ }
31685
+ }
31686
+ | {
31687
+ /** ID of the action attempt. */
31688
+ action_attempt_id: string
31689
+ status: 'pending'
31690
+ /** Result of the action attempt. Null for pending action attempts. */
31691
+ result: null
31692
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31693
+ error: null
31694
+ action_type: 'CREATE_ACCESS_CODE'
31695
+ }
31696
+ | {
31697
+ /** ID of the action attempt. */
31698
+ action_attempt_id: string
31699
+ status: 'success'
31700
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31701
+ error: null
31702
+ action_type: 'CREATE_ACCESS_CODE'
31703
+ result: {
31704
+ access_code?: any
31705
+ }
31706
+ }
31707
+ | {
31708
+ /** ID of the action attempt. */
31709
+ action_attempt_id: string
31710
+ status: 'error'
31711
+ /** Result of the action attempt. Null for failed action attempts. */
31712
+ result: null
31713
+ action_type: 'CREATE_ACCESS_CODE'
31714
+ error: {
31715
+ type: string
31716
+ message: string
31717
+ }
31718
+ }
31719
+ | {
31720
+ /** ID of the action attempt. */
31721
+ action_attempt_id: string
31722
+ status: 'pending'
31723
+ /** Result of the action attempt. Null for pending action attempts. */
31724
+ result: null
31725
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31726
+ error: null
31727
+ action_type: 'DELETE_ACCESS_CODE'
31728
+ }
31729
+ | {
31730
+ /** ID of the action attempt. */
31731
+ action_attempt_id: string
31732
+ status: 'success'
31733
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31734
+ error: null
31735
+ action_type: 'DELETE_ACCESS_CODE'
31736
+ result: {}
31737
+ }
31738
+ | {
31739
+ /** ID of the action attempt. */
31740
+ action_attempt_id: string
31741
+ status: 'error'
31742
+ /** Result of the action attempt. Null for failed action attempts. */
31743
+ result: null
31744
+ action_type: 'DELETE_ACCESS_CODE'
31745
+ error: {
31746
+ type: string
31747
+ message: string
31748
+ }
31749
+ }
31750
+ | {
31751
+ /** ID of the action attempt. */
31752
+ action_attempt_id: string
31753
+ status: 'pending'
31754
+ /** Result of the action attempt. Null for pending action attempts. */
31755
+ result: null
31756
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31757
+ error: null
31758
+ action_type: 'UPDATE_ACCESS_CODE'
31759
+ }
31760
+ | {
31761
+ /** ID of the action attempt. */
31762
+ action_attempt_id: string
31763
+ status: 'success'
31764
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31765
+ error: null
31766
+ action_type: 'UPDATE_ACCESS_CODE'
31767
+ result: {
31768
+ access_code?: any
31769
+ }
31770
+ }
31771
+ | {
31772
+ /** ID of the action attempt. */
31773
+ action_attempt_id: string
31774
+ status: 'error'
31775
+ /** Result of the action attempt. Null for failed action attempts. */
31776
+ result: null
31777
+ action_type: 'UPDATE_ACCESS_CODE'
31778
+ error: {
31779
+ type: string
31780
+ message: string
31781
+ }
31782
+ }
31783
+ | {
31784
+ /** ID of the action attempt. */
31785
+ action_attempt_id: string
31786
+ status: 'pending'
31787
+ /** Result of the action attempt. Null for pending action attempts. */
31788
+ result: null
31789
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31790
+ error: null
31791
+ action_type: 'CREATE_NOISE_THRESHOLD'
31792
+ }
31793
+ | {
31794
+ /** ID of the action attempt. */
31795
+ action_attempt_id: string
31796
+ status: 'success'
31797
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31798
+ error: null
31799
+ action_type: 'CREATE_NOISE_THRESHOLD'
31800
+ result: {
31801
+ noise_threshold?: any
31802
+ }
31803
+ }
31804
+ | {
31805
+ /** ID of the action attempt. */
31806
+ action_attempt_id: string
31807
+ status: 'error'
31808
+ /** Result of the action attempt. Null for failed action attempts. */
31809
+ result: null
31810
+ action_type: 'CREATE_NOISE_THRESHOLD'
31811
+ error: {
31812
+ type: string
31813
+ message: string
31814
+ }
31815
+ }
31816
+ | {
31817
+ /** ID of the action attempt. */
31818
+ action_attempt_id: string
31819
+ status: 'pending'
31820
+ /** Result of the action attempt. Null for pending action attempts. */
31821
+ result: null
31822
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31823
+ error: null
31824
+ action_type: 'DELETE_NOISE_THRESHOLD'
31825
+ }
31826
+ | {
31827
+ /** ID of the action attempt. */
31828
+ action_attempt_id: string
31829
+ status: 'success'
31830
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31831
+ error: null
31832
+ action_type: 'DELETE_NOISE_THRESHOLD'
31833
+ result: {}
31834
+ }
31835
+ | {
31836
+ /** ID of the action attempt. */
31837
+ action_attempt_id: string
31838
+ status: 'error'
31839
+ /** Result of the action attempt. Null for failed action attempts. */
31840
+ result: null
31841
+ action_type: 'DELETE_NOISE_THRESHOLD'
31842
+ error: {
31843
+ type: string
31844
+ message: string
31845
+ }
31846
+ }
31847
+ | {
31848
+ /** ID of the action attempt. */
31849
+ action_attempt_id: string
31850
+ status: 'pending'
31851
+ /** Result of the action attempt. Null for pending action attempts. */
31852
+ result: null
31853
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31854
+ error: null
31855
+ action_type: 'UPDATE_NOISE_THRESHOLD'
31856
+ }
31857
+ | {
31858
+ /** ID of the action attempt. */
31859
+ action_attempt_id: string
31860
+ status: 'success'
31861
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31862
+ error: null
31863
+ action_type: 'UPDATE_NOISE_THRESHOLD'
31864
+ result: {
31865
+ noise_threshold?: any
31866
+ }
31867
+ }
31868
+ | {
31869
+ /** ID of the action attempt. */
31870
+ action_attempt_id: string
31871
+ status: 'error'
31872
+ /** Result of the action attempt. Null for failed action attempts. */
31873
+ result: null
31874
+ action_type: 'UPDATE_NOISE_THRESHOLD'
31875
+ error: {
31876
+ type: string
31877
+ message: string
31878
+ }
31879
+ }
31880
+ }
31881
+ }
31882
+ '/locks/simulate/manual_lock_via_keypad': {
31883
+ route: '/locks/simulate/manual_lock_via_keypad'
31884
+ method: 'POST'
31885
+ queryParams: {}
31886
+ jsonBody: {
31887
+ device_id: string
31888
+ }
31889
+ commonParams: {}
31890
+ formData: {}
31891
+ jsonResponse: {
31892
+ /** */
31893
+ action_attempt:
31894
+ | {
31895
+ /** ID of the action attempt. */
31896
+ action_attempt_id: string
31897
+ status: 'pending'
31898
+ /** Result of the action attempt. Null for pending action attempts. */
31899
+ result: null
31900
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31901
+ error: null
31902
+ action_type: 'LOCK_DOOR'
31903
+ }
31904
+ | {
31905
+ /** ID of the action attempt. */
31906
+ action_attempt_id: string
31907
+ status: 'success'
31908
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31909
+ error: null
31910
+ action_type: 'LOCK_DOOR'
31911
+ result: {}
31912
+ }
31913
+ | {
31914
+ /** ID of the action attempt. */
31915
+ action_attempt_id: string
31916
+ status: 'error'
31917
+ /** Result of the action attempt. Null for failed action attempts. */
31918
+ result: null
31919
+ action_type: 'LOCK_DOOR'
31920
+ error: {
31921
+ type: string
31922
+ message: string
31923
+ }
31924
+ }
31925
+ | {
31926
+ /** ID of the action attempt. */
31927
+ action_attempt_id: string
31928
+ status: 'pending'
31929
+ /** Result of the action attempt. Null for pending action attempts. */
31930
+ result: null
31931
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31932
+ error: null
31933
+ action_type: 'UNLOCK_DOOR'
31934
+ }
31935
+ | {
31936
+ /** ID of the action attempt. */
31937
+ action_attempt_id: string
31938
+ status: 'success'
31939
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31940
+ error: null
31941
+ action_type: 'UNLOCK_DOOR'
31942
+ result: {}
31943
+ }
31944
+ | {
31945
+ /** ID of the action attempt. */
31946
+ action_attempt_id: string
31947
+ status: 'error'
31948
+ /** Result of the action attempt. Null for failed action attempts. */
31949
+ result: null
31950
+ action_type: 'UNLOCK_DOOR'
31951
+ error: {
31952
+ type: string
31953
+ message: string
31954
+ }
31955
+ }
31956
+ | {
31957
+ /** ID of the action attempt. */
31958
+ action_attempt_id: string
31959
+ status: 'pending'
31960
+ /** Result of the action attempt. Null for pending action attempts. */
31961
+ result: null
31962
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31963
+ error: null
31964
+ action_type: 'SCAN_CREDENTIAL'
31965
+ }
31966
+ | {
31967
+ /** ID of the action attempt. */
31968
+ action_attempt_id: string
31969
+ status: 'success'
31970
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31971
+ error: null
31972
+ action_type: 'SCAN_CREDENTIAL'
31973
+ result: {
31974
+ /** Snapshot of credential data read from physical encoder. */
31975
+ acs_credential_on_encoder: {
31976
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
31977
+ created_at: string | null
31978
+ is_issued: boolean | null
31979
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
31980
+ starts_at: string | null
31981
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
31982
+ ends_at: string | null
31983
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31984
+ card_number: string | null
31985
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31986
+ visionline_metadata?:
31987
+ | {
31988
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31989
+ card_id: string
31990
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
31991
+ cancelled: boolean
31992
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
31993
+ discarded: boolean
31994
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
31995
+ expired: boolean
31996
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
31997
+ overwritten: boolean
31998
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
31999
+ overridden?: boolean | undefined
32000
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
32001
+ pending_auto_update: boolean
32002
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32003
+ card_format: 'TLCode' | 'rfid48'
32004
+ /** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32005
+ card_holder?: string | undefined
32006
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32007
+ number_of_issued_cards: number
32008
+ /** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32009
+ guest_acs_entrance_ids?: string[] | undefined
32010
+ /** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32011
+ common_acs_entrance_ids?: string[] | undefined
32012
+ }
32013
+ | undefined
32014
+ } | null
32015
+ /** Matching acs_credential currently encoded on this card. */
32016
+ acs_credential_on_seam:
32017
+ | (
32018
+ | {
32019
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32020
+ acs_credential_id: string
32021
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
32022
+ acs_user_id?: string | undefined
32023
+ acs_credential_pool_id?: string | undefined
32024
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32025
+ acs_system_id: string
32026
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32027
+ parent_acs_credential_id?: string | undefined
32028
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32029
+ display_name: string
32030
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32031
+ code?: (string | undefined) | null
32032
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
32033
+ is_one_time_use?: boolean | undefined
32034
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32035
+ card_number?: (string | undefined) | null
32036
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32037
+ is_issued?: boolean | undefined
32038
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32039
+ issued_at?: (string | undefined) | null
32040
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32041
+ access_method: 'code' | 'card' | 'mobile_key'
32042
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
32043
+ external_type?:
32044
+ | (
32045
+ | 'pti_card'
32046
+ | 'brivo_credential'
32047
+ | 'hid_credential'
32048
+ | 'visionline_card'
32049
+ | 'salto_ks_credential'
32050
+ | 'assa_abloy_vostio_key'
32051
+ | 'salto_space_key'
32052
+ )
32053
+ | undefined
32054
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32055
+ external_type_display_name?: string | undefined
32056
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32057
+ created_at: string
32058
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32059
+ workspace_id: string
32060
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
32061
+ starts_at?: string | undefined
32062
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
32063
+ ends_at?: string | undefined
32064
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32065
+ errors: Array<{
32066
+ error_code: string
32067
+ message: string
32068
+ }>
32069
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32070
+ warnings: Array<
32071
+ | {
32072
+ /** Date and time at which Seam created the warning. */
32073
+ created_at: string
32074
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32075
+ message: string
32076
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32077
+ warning_code: 'waiting_to_be_issued'
32078
+ }
32079
+ | {
32080
+ /** Date and time at which Seam created the warning. */
32081
+ created_at: string
32082
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32083
+ message: string
32084
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32085
+ warning_code: 'schedule_externally_modified'
32086
+ }
32087
+ | {
32088
+ /** Date and time at which Seam created the warning. */
32089
+ created_at: string
32090
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32091
+ message: string
32092
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32093
+ warning_code: 'schedule_modified'
32094
+ }
32095
+ | {
32096
+ /** Date and time at which Seam created the warning. */
32097
+ created_at: string
32098
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32099
+ message: string
32100
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32101
+ warning_code: 'being_deleted'
32102
+ }
32103
+ | {
32104
+ /** Date and time at which Seam created the warning. */
32105
+ created_at: string
32106
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32107
+ message: string
32108
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32109
+ warning_code: 'unknown_issue_with_acs_credential'
32110
+ }
32111
+ | {
32112
+ /** Date and time at which Seam created the warning. */
32113
+ created_at: string
32114
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32115
+ message: string
32116
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32117
+ warning_code: 'needs_to_be_reissued'
32118
+ }
32119
+ >
32120
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32121
+ is_multi_phone_sync_credential?: boolean | undefined
32122
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
32123
+ is_latest_desired_state_synced_with_provider?:
32124
+ | (boolean | null)
32125
+ | undefined
32126
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
32127
+ latest_desired_state_synced_with_provider_at?:
32128
+ | (string | null)
32129
+ | undefined
32130
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32131
+ visionline_metadata?:
32132
+ | {
32133
+ card_function_type: 'guest' | 'staff'
32134
+ joiner_acs_credential_ids?: string[] | undefined
32135
+ guest_acs_entrance_ids?: string[] | undefined
32136
+ common_acs_entrance_ids?: string[] | undefined
32137
+ is_valid?: boolean | undefined
32138
+ auto_join?: boolean | undefined
32139
+ card_id?: string | undefined
32140
+ credential_id?: string | undefined
32141
+ }
32142
+ | undefined
32143
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32144
+ assa_abloy_vostio_metadata?:
32145
+ | {
32146
+ override_guest_acs_entrance_ids?:
32147
+ | string[]
32148
+ | undefined
32149
+ key_id?: string | undefined
32150
+ key_issuing_request_id?: string | undefined
32151
+ door_names?: string[] | undefined
32152
+ endpoint_id?: string | undefined
32153
+ }
32154
+ | undefined
32155
+ is_managed: true
32156
+ }
32157
+ | {
32158
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32159
+ acs_credential_id: string
32160
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
32161
+ acs_user_id?: string | undefined
32162
+ acs_credential_pool_id?: string | undefined
32163
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32164
+ acs_system_id: string
32165
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32166
+ parent_acs_credential_id?: string | undefined
32167
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32168
+ display_name: string
32169
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32170
+ code?: (string | undefined) | null
32171
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
32172
+ is_one_time_use?: boolean | undefined
32173
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32174
+ card_number?: (string | undefined) | null
32175
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32176
+ is_issued?: boolean | undefined
32177
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32178
+ issued_at?: (string | undefined) | null
32179
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32180
+ access_method: 'code' | 'card' | 'mobile_key'
32181
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
32182
+ external_type?:
32183
+ | (
32184
+ | 'pti_card'
32185
+ | 'brivo_credential'
32186
+ | 'hid_credential'
32187
+ | 'visionline_card'
32188
+ | 'salto_ks_credential'
32189
+ | 'assa_abloy_vostio_key'
32190
+ | 'salto_space_key'
32191
+ )
32192
+ | undefined
32193
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32194
+ external_type_display_name?: string | undefined
32195
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32196
+ created_at: string
32197
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32198
+ workspace_id: string
32199
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
32200
+ starts_at?: string | undefined
32201
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
32202
+ ends_at?: string | undefined
32203
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32204
+ errors: Array<{
32205
+ error_code: string
32206
+ message: string
32207
+ }>
32208
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32209
+ warnings: Array<
32210
+ | {
32211
+ /** Date and time at which Seam created the warning. */
32212
+ created_at: string
32213
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32214
+ message: string
32215
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32216
+ warning_code: 'waiting_to_be_issued'
32217
+ }
32218
+ | {
32219
+ /** Date and time at which Seam created the warning. */
32220
+ created_at: string
32221
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32222
+ message: string
32223
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32224
+ warning_code: 'schedule_externally_modified'
32225
+ }
32226
+ | {
32227
+ /** Date and time at which Seam created the warning. */
32228
+ created_at: string
32229
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32230
+ message: string
32231
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32232
+ warning_code: 'schedule_modified'
32233
+ }
32234
+ | {
32235
+ /** Date and time at which Seam created the warning. */
32236
+ created_at: string
32237
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32238
+ message: string
32239
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32240
+ warning_code: 'being_deleted'
32241
+ }
32242
+ | {
32243
+ /** Date and time at which Seam created the warning. */
32244
+ created_at: string
32245
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32246
+ message: string
32247
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32248
+ warning_code: 'unknown_issue_with_acs_credential'
32249
+ }
32250
+ | {
32251
+ /** Date and time at which Seam created the warning. */
32252
+ created_at: string
32253
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32254
+ message: string
32255
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32256
+ warning_code: 'needs_to_be_reissued'
32257
+ }
32258
+ >
32259
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32260
+ is_multi_phone_sync_credential?: boolean | undefined
32261
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
32262
+ is_latest_desired_state_synced_with_provider?:
32263
+ | (boolean | null)
32264
+ | undefined
32265
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
32266
+ latest_desired_state_synced_with_provider_at?:
32267
+ | (string | null)
32268
+ | undefined
32269
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32270
+ visionline_metadata?:
32271
+ | {
32272
+ card_function_type: 'guest' | 'staff'
32273
+ joiner_acs_credential_ids?: string[] | undefined
32274
+ guest_acs_entrance_ids?: string[] | undefined
32275
+ common_acs_entrance_ids?: string[] | undefined
32276
+ is_valid?: boolean | undefined
32277
+ auto_join?: boolean | undefined
32278
+ card_id?: string | undefined
32279
+ credential_id?: string | undefined
32280
+ }
32281
+ | undefined
32282
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32283
+ assa_abloy_vostio_metadata?:
32284
+ | {
32285
+ override_guest_acs_entrance_ids?:
32286
+ | string[]
32287
+ | undefined
32288
+ key_id?: string | undefined
32289
+ key_issuing_request_id?: string | undefined
32290
+ door_names?: string[] | undefined
32291
+ endpoint_id?: string | undefined
32292
+ }
32293
+ | undefined
32294
+ is_managed: false
32295
+ }
32296
+ )
32297
+ | null
32298
+ warnings: Array<{
32299
+ warning_code:
32300
+ | 'acs_credential_on_encoder_out_of_sync'
32301
+ | 'acs_credential_on_seam_not_found'
32302
+ warning_message: string
32303
+ }>
32304
+ }
32305
+ }
32306
+ | {
32307
+ /** ID of the action attempt. */
32308
+ action_attempt_id: string
32309
+ status: 'error'
32310
+ /** Result of the action attempt. Null for failed action attempts. */
32311
+ result: null
32312
+ action_type: 'SCAN_CREDENTIAL'
32313
+ error:
32314
+ | {
32315
+ /** Type of the error associated with the action attempt. */
32316
+ type: 'uncategorized_error'
32317
+ /** Message for the error associated with the action attempt. */
32318
+ message: string
32319
+ }
32320
+ | {
32321
+ /** Type of the error associated with the action attempt. */
32322
+ type: 'action_attempt_expired'
32323
+ /** Message for the error associated with the action attempt. */
32324
+ message: string
32325
+ }
32326
+ | {
32327
+ type: 'no_credential_on_encoder'
32328
+ message: string
32329
+ }
32330
+ }
32331
+ | {
32332
+ /** ID of the action attempt. */
32333
+ action_attempt_id: string
32334
+ status: 'pending'
32335
+ /** Result of the action attempt. Null for pending action attempts. */
32336
+ result: null
32337
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32338
+ error: null
32339
+ /** Type of action that the action attempt tracks. */
32340
+ action_type: 'ENCODE_CREDENTIAL'
32341
+ }
32342
+ | {
32343
+ /** ID of the action attempt. */
32344
+ action_attempt_id: string
32345
+ status: 'success'
32346
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32347
+ error: null
32348
+ /** Type of action that the action attempt tracks. */
32349
+ action_type: 'ENCODE_CREDENTIAL'
32350
+ /** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
32351
+ result:
32352
+ | {
32353
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32354
+ acs_credential_id: string
32355
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
32356
+ acs_user_id?: string | undefined
32357
+ acs_credential_pool_id?: string | undefined
32358
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32359
+ acs_system_id: string
32360
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32361
+ parent_acs_credential_id?: string | undefined
32362
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32363
+ display_name: string
32364
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32365
+ code?: (string | undefined) | null
32366
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
32367
+ is_one_time_use?: boolean | undefined
32368
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32369
+ card_number?: (string | undefined) | null
32370
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32371
+ is_issued?: boolean | undefined
32372
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32373
+ issued_at?: (string | undefined) | null
32374
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32375
+ access_method: 'code' | 'card' | 'mobile_key'
32376
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
32377
+ external_type?:
32378
+ | (
32379
+ | 'pti_card'
32380
+ | 'brivo_credential'
32381
+ | 'hid_credential'
32382
+ | 'visionline_card'
32383
+ | 'salto_ks_credential'
32384
+ | 'assa_abloy_vostio_key'
32385
+ | 'salto_space_key'
32386
+ )
32387
+ | undefined
32388
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32389
+ external_type_display_name?: string | undefined
32390
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32391
+ created_at: string
32392
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32393
+ workspace_id: string
32394
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
32395
+ starts_at?: string | undefined
32396
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
32397
+ ends_at?: string | undefined
32398
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32399
+ errors: Array<{
32400
+ error_code: string
32401
+ message: string
32402
+ }>
32403
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32404
+ warnings: Array<
32405
+ | {
32406
+ /** Date and time at which Seam created the warning. */
32407
+ created_at: string
32408
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32409
+ message: string
32410
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32411
+ warning_code: 'waiting_to_be_issued'
32412
+ }
32413
+ | {
32414
+ /** Date and time at which Seam created the warning. */
32415
+ created_at: string
32416
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32417
+ message: string
32418
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32419
+ warning_code: 'schedule_externally_modified'
32420
+ }
32421
+ | {
32422
+ /** Date and time at which Seam created the warning. */
32423
+ created_at: string
32424
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32425
+ message: string
32426
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32427
+ warning_code: 'schedule_modified'
32428
+ }
32429
+ | {
32430
+ /** Date and time at which Seam created the warning. */
32431
+ created_at: string
32432
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32433
+ message: string
32434
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32435
+ warning_code: 'being_deleted'
32436
+ }
32437
+ | {
32438
+ /** Date and time at which Seam created the warning. */
32439
+ created_at: string
32440
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32441
+ message: string
32442
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32443
+ warning_code: 'unknown_issue_with_acs_credential'
32444
+ }
32445
+ | {
32446
+ /** Date and time at which Seam created the warning. */
32447
+ created_at: string
32448
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32449
+ message: string
32450
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32451
+ warning_code: 'needs_to_be_reissued'
32452
+ }
32453
+ >
32454
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32455
+ is_multi_phone_sync_credential?: boolean | undefined
32456
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
32457
+ is_latest_desired_state_synced_with_provider?:
32458
+ | (boolean | null)
32459
+ | undefined
32460
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
32461
+ latest_desired_state_synced_with_provider_at?:
32462
+ | (string | null)
32463
+ | undefined
32464
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32465
+ visionline_metadata?:
32466
+ | {
32467
+ card_function_type: 'guest' | 'staff'
32468
+ joiner_acs_credential_ids?: string[] | undefined
32469
+ guest_acs_entrance_ids?: string[] | undefined
32470
+ common_acs_entrance_ids?: string[] | undefined
32471
+ is_valid?: boolean | undefined
32472
+ auto_join?: boolean | undefined
32473
+ card_id?: string | undefined
32474
+ credential_id?: string | undefined
32475
+ }
32476
+ | undefined
32477
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32478
+ assa_abloy_vostio_metadata?:
32479
+ | {
32480
+ override_guest_acs_entrance_ids?: string[] | undefined
32481
+ key_id?: string | undefined
32482
+ key_issuing_request_id?: string | undefined
32483
+ door_names?: string[] | undefined
32484
+ endpoint_id?: string | undefined
32485
+ }
32486
+ | undefined
32487
+ is_managed: true
32488
+ }
32489
+ | {
32490
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32491
+ acs_credential_id: string
32492
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
32493
+ acs_user_id?: string | undefined
32494
+ acs_credential_pool_id?: string | undefined
32495
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32496
+ acs_system_id: string
32497
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32498
+ parent_acs_credential_id?: string | undefined
32499
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32500
+ display_name: string
32501
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32502
+ code?: (string | undefined) | null
32503
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
32504
+ is_one_time_use?: boolean | undefined
32505
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32506
+ card_number?: (string | undefined) | null
32507
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32508
+ is_issued?: boolean | undefined
32509
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32510
+ issued_at?: (string | undefined) | null
32511
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32512
+ access_method: 'code' | 'card' | 'mobile_key'
32513
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
32514
+ external_type?:
32515
+ | (
32516
+ | 'pti_card'
32517
+ | 'brivo_credential'
32518
+ | 'hid_credential'
32519
+ | 'visionline_card'
32520
+ | 'salto_ks_credential'
32521
+ | 'assa_abloy_vostio_key'
32522
+ | 'salto_space_key'
32523
+ )
32524
+ | undefined
32525
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32526
+ external_type_display_name?: string | undefined
32527
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32528
+ created_at: string
32529
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32530
+ workspace_id: string
32531
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
32532
+ starts_at?: string | undefined
32533
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
32534
+ ends_at?: string | undefined
32535
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32536
+ errors: Array<{
32537
+ error_code: string
32538
+ message: string
32539
+ }>
32540
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32541
+ warnings: Array<
32542
+ | {
32543
+ /** Date and time at which Seam created the warning. */
32544
+ created_at: string
32545
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32546
+ message: string
32547
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32548
+ warning_code: 'waiting_to_be_issued'
32549
+ }
32550
+ | {
32551
+ /** Date and time at which Seam created the warning. */
32552
+ created_at: string
32553
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32554
+ message: string
32555
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32556
+ warning_code: 'schedule_externally_modified'
32557
+ }
32558
+ | {
32559
+ /** Date and time at which Seam created the warning. */
32560
+ created_at: string
32561
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32562
+ message: string
32563
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32564
+ warning_code: 'schedule_modified'
32565
+ }
32566
+ | {
32567
+ /** Date and time at which Seam created the warning. */
32568
+ created_at: string
32569
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32570
+ message: string
32571
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32572
+ warning_code: 'being_deleted'
32573
+ }
32574
+ | {
32575
+ /** Date and time at which Seam created the warning. */
32576
+ created_at: string
32577
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32578
+ message: string
32579
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32580
+ warning_code: 'unknown_issue_with_acs_credential'
32581
+ }
32582
+ | {
32583
+ /** Date and time at which Seam created the warning. */
32584
+ created_at: string
32585
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32586
+ message: string
32587
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32588
+ warning_code: 'needs_to_be_reissued'
32589
+ }
32590
+ >
32591
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32592
+ is_multi_phone_sync_credential?: boolean | undefined
32593
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
32594
+ is_latest_desired_state_synced_with_provider?:
32595
+ | (boolean | null)
32596
+ | undefined
32597
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
32598
+ latest_desired_state_synced_with_provider_at?:
32599
+ | (string | null)
32600
+ | undefined
32601
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32602
+ visionline_metadata?:
32603
+ | {
32604
+ card_function_type: 'guest' | 'staff'
32605
+ joiner_acs_credential_ids?: string[] | undefined
32606
+ guest_acs_entrance_ids?: string[] | undefined
32607
+ common_acs_entrance_ids?: string[] | undefined
32608
+ is_valid?: boolean | undefined
32609
+ auto_join?: boolean | undefined
32610
+ card_id?: string | undefined
32611
+ credential_id?: string | undefined
32612
+ }
32613
+ | undefined
32614
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32615
+ assa_abloy_vostio_metadata?:
32616
+ | {
32617
+ override_guest_acs_entrance_ids?: string[] | undefined
32618
+ key_id?: string | undefined
32619
+ key_issuing_request_id?: string | undefined
32620
+ door_names?: string[] | undefined
32621
+ endpoint_id?: string | undefined
32622
+ }
32623
+ | undefined
32624
+ is_managed: false
32625
+ }
32626
+ }
32627
+ | {
32628
+ /** ID of the action attempt. */
32629
+ action_attempt_id: string
32630
+ status: 'error'
32631
+ /** Result of the action attempt. Null for failed action attempts. */
32632
+ result: null
32633
+ /** Type of action that the action attempt tracks. */
32634
+ action_type: 'ENCODE_CREDENTIAL'
32635
+ error:
32636
+ | {
32637
+ /** Type of the error associated with the action attempt. */
32638
+ type: 'uncategorized_error'
32639
+ /** Message for the error associated with the action attempt. */
32640
+ message: string
32641
+ }
32642
+ | {
32643
+ /** Type of the error associated with the action attempt. */
32644
+ type: 'action_attempt_expired'
32645
+ /** Message for the error associated with the action attempt. */
32646
+ message: string
32647
+ }
32648
+ | {
32649
+ type: 'no_credential_on_encoder'
32650
+ message: string
32651
+ }
32652
+ | {
32653
+ type: 'incompatible_card_format'
32654
+ message: string
32655
+ }
32656
+ | {
32657
+ type: 'credential_cannot_be_reissued'
32658
+ message: string
32659
+ }
32660
+ }
32661
+ | {
32662
+ /** ID of the action attempt. */
32663
+ action_attempt_id: string
32664
+ status: 'pending'
32665
+ /** Result of the action attempt. Null for pending action attempts. */
32666
+ result: null
32667
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32668
+ error: null
32669
+ action_type: 'RESET_SANDBOX_WORKSPACE'
32670
+ }
32671
+ | {
32672
+ /** ID of the action attempt. */
32673
+ action_attempt_id: string
32674
+ status: 'success'
32675
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32676
+ error: null
32677
+ action_type: 'RESET_SANDBOX_WORKSPACE'
32678
+ result: {}
32679
+ }
32680
+ | {
32681
+ /** ID of the action attempt. */
32682
+ action_attempt_id: string
32683
+ status: 'error'
32684
+ /** Result of the action attempt. Null for failed action attempts. */
32685
+ result: null
32686
+ action_type: 'RESET_SANDBOX_WORKSPACE'
32687
+ error: {
32688
+ type: string
32689
+ message: string
32690
+ }
32691
+ }
32692
+ | {
32693
+ /** ID of the action attempt. */
32694
+ action_attempt_id: string
32695
+ status: 'pending'
32696
+ /** Result of the action attempt. Null for pending action attempts. */
32697
+ result: null
32698
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32699
+ error: null
32700
+ action_type: 'SET_FAN_MODE'
32701
+ }
32702
+ | {
32703
+ /** ID of the action attempt. */
32704
+ action_attempt_id: string
32705
+ status: 'success'
32706
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32707
+ error: null
32708
+ action_type: 'SET_FAN_MODE'
32709
+ result: {}
32710
+ }
32711
+ | {
32712
+ /** ID of the action attempt. */
32713
+ action_attempt_id: string
32714
+ status: 'error'
32715
+ /** Result of the action attempt. Null for failed action attempts. */
32716
+ result: null
32717
+ action_type: 'SET_FAN_MODE'
32718
+ error: {
32719
+ type: string
32720
+ message: string
32721
+ }
32722
+ }
32723
+ | {
32724
+ /** ID of the action attempt. */
32725
+ action_attempt_id: string
32726
+ status: 'pending'
32727
+ /** Result of the action attempt. Null for pending action attempts. */
32728
+ result: null
32729
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32730
+ error: null
32731
+ action_type: 'SET_HVAC_MODE'
32732
+ }
32733
+ | {
32734
+ /** ID of the action attempt. */
32735
+ action_attempt_id: string
32736
+ status: 'success'
32737
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32738
+ error: null
32739
+ action_type: 'SET_HVAC_MODE'
32740
+ result: {}
32741
+ }
32742
+ | {
32743
+ /** ID of the action attempt. */
32744
+ action_attempt_id: string
32745
+ status: 'error'
32746
+ /** Result of the action attempt. Null for failed action attempts. */
32747
+ result: null
32748
+ action_type: 'SET_HVAC_MODE'
32749
+ error: {
32750
+ type: string
32751
+ message: string
32752
+ }
32753
+ }
32754
+ | {
32755
+ /** ID of the action attempt. */
32756
+ action_attempt_id: string
32757
+ status: 'pending'
32758
+ /** Result of the action attempt. Null for pending action attempts. */
32759
+ result: null
32760
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32761
+ error: null
32762
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
32763
+ }
32764
+ | {
32765
+ /** ID of the action attempt. */
32766
+ action_attempt_id: string
32767
+ status: 'success'
32768
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32769
+ error: null
32770
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
32771
+ result: {}
32772
+ }
32773
+ | {
32774
+ /** ID of the action attempt. */
32775
+ action_attempt_id: string
32776
+ status: 'error'
32777
+ /** Result of the action attempt. Null for failed action attempts. */
32778
+ result: null
32779
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
32780
+ error: {
32781
+ type: string
32782
+ message: string
32783
+ }
32784
+ }
32785
+ | {
32786
+ /** ID of the action attempt. */
32787
+ action_attempt_id: string
32788
+ status: 'pending'
32789
+ /** Result of the action attempt. Null for pending action attempts. */
32790
+ result: null
32791
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32792
+ error: null
32793
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
32794
+ }
32795
+ | {
32796
+ /** ID of the action attempt. */
32797
+ action_attempt_id: string
32798
+ status: 'success'
32799
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32800
+ error: null
32801
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
32802
+ result: {}
32803
+ }
32804
+ | {
32805
+ /** ID of the action attempt. */
32806
+ action_attempt_id: string
32807
+ status: 'error'
32808
+ /** Result of the action attempt. Null for failed action attempts. */
32809
+ result: null
32810
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
32811
+ error: {
32812
+ type: string
32813
+ message: string
32814
+ }
32815
+ }
32816
+ | {
32817
+ /** ID of the action attempt. */
32818
+ action_attempt_id: string
32819
+ status: 'pending'
32820
+ /** Result of the action attempt. Null for pending action attempts. */
32821
+ result: null
32822
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32823
+ error: null
32824
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
32825
+ }
32826
+ | {
32827
+ /** ID of the action attempt. */
32828
+ action_attempt_id: string
32829
+ status: 'success'
32830
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32831
+ error: null
32832
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
32833
+ result: {}
32834
+ }
32835
+ | {
32836
+ /** ID of the action attempt. */
32837
+ action_attempt_id: string
32838
+ status: 'error'
32839
+ /** Result of the action attempt. Null for failed action attempts. */
32840
+ result: null
32841
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
32842
+ error: {
32843
+ type: string
32844
+ message: string
32845
+ }
32846
+ }
32847
+ | {
32848
+ /** ID of the action attempt. */
32849
+ action_attempt_id: string
32850
+ status: 'pending'
32851
+ /** Result of the action attempt. Null for pending action attempts. */
32852
+ result: null
32853
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32854
+ error: null
32855
+ action_type: 'SYNC_ACCESS_CODES'
32856
+ }
32857
+ | {
32858
+ /** ID of the action attempt. */
32859
+ action_attempt_id: string
32860
+ status: 'success'
32861
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32862
+ error: null
32863
+ action_type: 'SYNC_ACCESS_CODES'
32864
+ result: {}
32865
+ }
32866
+ | {
32867
+ /** ID of the action attempt. */
32868
+ action_attempt_id: string
32869
+ status: 'error'
32870
+ /** Result of the action attempt. Null for failed action attempts. */
32871
+ result: null
32872
+ action_type: 'SYNC_ACCESS_CODES'
32873
+ error: {
32874
+ type: string
32875
+ message: string
32876
+ }
32877
+ }
32878
+ | {
32879
+ /** ID of the action attempt. */
32880
+ action_attempt_id: string
32881
+ status: 'pending'
32882
+ /** Result of the action attempt. Null for pending action attempts. */
32883
+ result: null
32884
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32885
+ error: null
32886
+ action_type: 'CREATE_ACCESS_CODE'
32887
+ }
32888
+ | {
32889
+ /** ID of the action attempt. */
32890
+ action_attempt_id: string
32891
+ status: 'success'
32892
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32893
+ error: null
32894
+ action_type: 'CREATE_ACCESS_CODE'
32895
+ result: {
32896
+ access_code?: any
32897
+ }
32898
+ }
32899
+ | {
32900
+ /** ID of the action attempt. */
32901
+ action_attempt_id: string
32902
+ status: 'error'
32903
+ /** Result of the action attempt. Null for failed action attempts. */
32904
+ result: null
32905
+ action_type: 'CREATE_ACCESS_CODE'
32906
+ error: {
32907
+ type: string
32908
+ message: string
32909
+ }
32910
+ }
32911
+ | {
32912
+ /** ID of the action attempt. */
32913
+ action_attempt_id: string
32914
+ status: 'pending'
32915
+ /** Result of the action attempt. Null for pending action attempts. */
32916
+ result: null
32917
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32918
+ error: null
32919
+ action_type: 'DELETE_ACCESS_CODE'
32920
+ }
32921
+ | {
32922
+ /** ID of the action attempt. */
32923
+ action_attempt_id: string
32924
+ status: 'success'
32925
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32926
+ error: null
32927
+ action_type: 'DELETE_ACCESS_CODE'
32928
+ result: {}
32929
+ }
32930
+ | {
32931
+ /** ID of the action attempt. */
32932
+ action_attempt_id: string
32933
+ status: 'error'
32934
+ /** Result of the action attempt. Null for failed action attempts. */
32935
+ result: null
32936
+ action_type: 'DELETE_ACCESS_CODE'
32937
+ error: {
32938
+ type: string
32939
+ message: string
32940
+ }
32941
+ }
32942
+ | {
32943
+ /** ID of the action attempt. */
32944
+ action_attempt_id: string
32945
+ status: 'pending'
32946
+ /** Result of the action attempt. Null for pending action attempts. */
32947
+ result: null
32948
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32949
+ error: null
32950
+ action_type: 'UPDATE_ACCESS_CODE'
32951
+ }
32952
+ | {
32953
+ /** ID of the action attempt. */
32954
+ action_attempt_id: string
32955
+ status: 'success'
32956
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32957
+ error: null
32958
+ action_type: 'UPDATE_ACCESS_CODE'
32959
+ result: {
32960
+ access_code?: any
32961
+ }
32962
+ }
32963
+ | {
32964
+ /** ID of the action attempt. */
32965
+ action_attempt_id: string
32966
+ status: 'error'
32967
+ /** Result of the action attempt. Null for failed action attempts. */
32968
+ result: null
32969
+ action_type: 'UPDATE_ACCESS_CODE'
32970
+ error: {
32971
+ type: string
32972
+ message: string
32973
+ }
32974
+ }
32975
+ | {
32976
+ /** ID of the action attempt. */
32977
+ action_attempt_id: string
32978
+ status: 'pending'
32979
+ /** Result of the action attempt. Null for pending action attempts. */
32980
+ result: null
32981
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32982
+ error: null
32983
+ action_type: 'CREATE_NOISE_THRESHOLD'
32984
+ }
32985
+ | {
32986
+ /** ID of the action attempt. */
32987
+ action_attempt_id: string
32988
+ status: 'success'
32989
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32990
+ error: null
32991
+ action_type: 'CREATE_NOISE_THRESHOLD'
32992
+ result: {
32993
+ noise_threshold?: any
32994
+ }
32995
+ }
32996
+ | {
32997
+ /** ID of the action attempt. */
32998
+ action_attempt_id: string
32999
+ status: 'error'
33000
+ /** Result of the action attempt. Null for failed action attempts. */
33001
+ result: null
33002
+ action_type: 'CREATE_NOISE_THRESHOLD'
33003
+ error: {
33004
+ type: string
33005
+ message: string
33006
+ }
33007
+ }
33008
+ | {
33009
+ /** ID of the action attempt. */
33010
+ action_attempt_id: string
33011
+ status: 'pending'
33012
+ /** Result of the action attempt. Null for pending action attempts. */
33013
+ result: null
33014
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33015
+ error: null
33016
+ action_type: 'DELETE_NOISE_THRESHOLD'
33017
+ }
33018
+ | {
33019
+ /** ID of the action attempt. */
33020
+ action_attempt_id: string
33021
+ status: 'success'
33022
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33023
+ error: null
33024
+ action_type: 'DELETE_NOISE_THRESHOLD'
33025
+ result: {}
33026
+ }
33027
+ | {
33028
+ /** ID of the action attempt. */
33029
+ action_attempt_id: string
33030
+ status: 'error'
33031
+ /** Result of the action attempt. Null for failed action attempts. */
33032
+ result: null
33033
+ action_type: 'DELETE_NOISE_THRESHOLD'
33034
+ error: {
33035
+ type: string
33036
+ message: string
33037
+ }
33038
+ }
33039
+ | {
33040
+ /** ID of the action attempt. */
33041
+ action_attempt_id: string
33042
+ status: 'pending'
33043
+ /** Result of the action attempt. Null for pending action attempts. */
33044
+ result: null
33045
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33046
+ error: null
33047
+ action_type: 'UPDATE_NOISE_THRESHOLD'
33048
+ }
33049
+ | {
33050
+ /** ID of the action attempt. */
33051
+ action_attempt_id: string
33052
+ status: 'success'
33053
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33054
+ error: null
33055
+ action_type: 'UPDATE_NOISE_THRESHOLD'
33056
+ result: {
33057
+ noise_threshold?: any
33058
+ }
33059
+ }
33060
+ | {
33061
+ /** ID of the action attempt. */
33062
+ action_attempt_id: string
33063
+ status: 'error'
33064
+ /** Result of the action attempt. Null for failed action attempts. */
33065
+ result: null
33066
+ action_type: 'UPDATE_NOISE_THRESHOLD'
33067
+ error: {
33068
+ type: string
33069
+ message: string
33070
+ }
33071
+ }
33072
+ }
33073
+ }
33074
+ '/locks/unlock_door': {
33075
+ route: '/locks/unlock_door'
33076
+ method: 'POST'
33077
+ queryParams: {}
33078
+ jsonBody: {
33079
+ device_id: string
33080
+ sync?: boolean
33081
+ }
33082
+ commonParams: {}
33083
+ formData: {}
33084
+ jsonResponse: {
33085
+ /** */
33086
+ action_attempt:
33087
+ | {
33088
+ /** ID of the action attempt. */
33089
+ action_attempt_id: string
33090
+ status: 'pending'
33091
+ /** Result of the action attempt. Null for pending action attempts. */
33092
+ result: null
33093
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33094
+ error: null
33095
+ action_type: 'LOCK_DOOR'
33096
+ }
33097
+ | {
33098
+ /** ID of the action attempt. */
33099
+ action_attempt_id: string
33100
+ status: 'success'
33101
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33102
+ error: null
33103
+ action_type: 'LOCK_DOOR'
33104
+ result: {}
33105
+ }
33106
+ | {
33107
+ /** ID of the action attempt. */
33108
+ action_attempt_id: string
33109
+ status: 'error'
33110
+ /** Result of the action attempt. Null for failed action attempts. */
33111
+ result: null
33112
+ action_type: 'LOCK_DOOR'
33113
+ error: {
33114
+ type: string
33115
+ message: string
33116
+ }
33117
+ }
33118
+ | {
33119
+ /** ID of the action attempt. */
33120
+ action_attempt_id: string
33121
+ status: 'pending'
33122
+ /** Result of the action attempt. Null for pending action attempts. */
33123
+ result: null
33124
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33125
+ error: null
33126
+ action_type: 'UNLOCK_DOOR'
33127
+ }
33128
+ | {
33129
+ /** ID of the action attempt. */
33130
+ action_attempt_id: string
33131
+ status: 'success'
33132
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33133
+ error: null
33134
+ action_type: 'UNLOCK_DOOR'
33135
+ result: {}
33136
+ }
33137
+ | {
33138
+ /** ID of the action attempt. */
33139
+ action_attempt_id: string
33140
+ status: 'error'
33141
+ /** Result of the action attempt. Null for failed action attempts. */
33142
+ result: null
33143
+ action_type: 'UNLOCK_DOOR'
33144
+ error: {
33145
+ type: string
33146
+ message: string
33147
+ }
33148
+ }
33149
+ | {
33150
+ /** ID of the action attempt. */
33151
+ action_attempt_id: string
33152
+ status: 'pending'
33153
+ /** Result of the action attempt. Null for pending action attempts. */
33154
+ result: null
33155
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33156
+ error: null
33157
+ action_type: 'SCAN_CREDENTIAL'
33158
+ }
33159
+ | {
33160
+ /** ID of the action attempt. */
33161
+ action_attempt_id: string
33162
+ status: 'success'
33163
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33164
+ error: null
33165
+ action_type: 'SCAN_CREDENTIAL'
33166
+ result: {
33167
+ /** Snapshot of credential data read from physical encoder. */
33168
+ acs_credential_on_encoder: {
33169
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
33170
+ created_at: string | null
33171
+ is_issued: boolean | null
33172
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
33173
+ starts_at: string | null
33174
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
33175
+ ends_at: string | null
33176
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33177
+ card_number: string | null
33178
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33179
+ visionline_metadata?:
33180
+ | {
33181
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33182
+ card_id: string
33183
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
33184
+ cancelled: boolean
33185
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
33186
+ discarded: boolean
33187
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
33188
+ expired: boolean
33189
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
33190
+ overwritten: boolean
33191
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
33192
+ overridden?: boolean | undefined
33193
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
33194
+ pending_auto_update: boolean
33195
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33196
+ card_format: 'TLCode' | 'rfid48'
33197
+ /** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33198
+ card_holder?: string | undefined
33199
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33200
+ number_of_issued_cards: number
33201
+ /** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33202
+ guest_acs_entrance_ids?: string[] | undefined
33203
+ /** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33204
+ common_acs_entrance_ids?: string[] | undefined
33205
+ }
33206
+ | undefined
33207
+ } | null
33208
+ /** Matching acs_credential currently encoded on this card. */
33209
+ acs_credential_on_seam:
33210
+ | (
33211
+ | {
33212
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33213
+ acs_credential_id: string
33214
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
33215
+ acs_user_id?: string | undefined
33216
+ acs_credential_pool_id?: string | undefined
33217
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33218
+ acs_system_id: string
33219
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33220
+ parent_acs_credential_id?: string | undefined
33221
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33222
+ display_name: string
33223
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33224
+ code?: (string | undefined) | null
33225
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
33226
+ is_one_time_use?: boolean | undefined
33227
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33228
+ card_number?: (string | undefined) | null
33229
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
33230
+ is_issued?: boolean | undefined
33231
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
33232
+ issued_at?: (string | undefined) | null
33233
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
33234
+ access_method: 'code' | 'card' | 'mobile_key'
33235
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
33236
+ external_type?:
33237
+ | (
33238
+ | 'pti_card'
33239
+ | 'brivo_credential'
33240
+ | 'hid_credential'
33241
+ | 'visionline_card'
33242
+ | 'salto_ks_credential'
33243
+ | 'assa_abloy_vostio_key'
33244
+ | 'salto_space_key'
33245
+ )
33246
+ | undefined
33247
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33248
+ external_type_display_name?: string | undefined
33249
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
33250
+ created_at: string
33251
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33252
+ workspace_id: string
33253
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
33254
+ starts_at?: string | undefined
33255
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
33256
+ ends_at?: string | undefined
33257
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33258
+ errors: Array<{
33259
+ error_code: string
33260
+ message: string
33261
+ }>
33262
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33263
+ warnings: Array<
33264
+ | {
33265
+ /** Date and time at which Seam created the warning. */
33266
+ created_at: string
33267
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33268
+ message: string
33269
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33270
+ warning_code: 'waiting_to_be_issued'
33271
+ }
33272
+ | {
33273
+ /** Date and time at which Seam created the warning. */
33274
+ created_at: string
33275
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33276
+ message: string
33277
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33278
+ warning_code: 'schedule_externally_modified'
33279
+ }
33280
+ | {
33281
+ /** Date and time at which Seam created the warning. */
33282
+ created_at: string
33283
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33284
+ message: string
33285
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33286
+ warning_code: 'schedule_modified'
33287
+ }
33288
+ | {
33289
+ /** Date and time at which Seam created the warning. */
33290
+ created_at: string
33291
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33292
+ message: string
33293
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33294
+ warning_code: 'being_deleted'
33295
+ }
33296
+ | {
33297
+ /** Date and time at which Seam created the warning. */
33298
+ created_at: string
33299
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33300
+ message: string
33301
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33302
+ warning_code: 'unknown_issue_with_acs_credential'
33303
+ }
33304
+ | {
33305
+ /** Date and time at which Seam created the warning. */
33306
+ created_at: string
33307
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33308
+ message: string
33309
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33310
+ warning_code: 'needs_to_be_reissued'
33311
+ }
33312
+ >
33313
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
33314
+ is_multi_phone_sync_credential?: boolean | undefined
33315
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
33316
+ is_latest_desired_state_synced_with_provider?:
33317
+ | (boolean | null)
33318
+ | undefined
33319
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
33320
+ latest_desired_state_synced_with_provider_at?:
33321
+ | (string | null)
33322
+ | undefined
33323
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33324
+ visionline_metadata?:
33325
+ | {
33326
+ card_function_type: 'guest' | 'staff'
33327
+ joiner_acs_credential_ids?: string[] | undefined
33328
+ guest_acs_entrance_ids?: string[] | undefined
33329
+ common_acs_entrance_ids?: string[] | undefined
33330
+ is_valid?: boolean | undefined
33331
+ auto_join?: boolean | undefined
33332
+ card_id?: string | undefined
33333
+ credential_id?: string | undefined
33334
+ }
33335
+ | undefined
33336
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33337
+ assa_abloy_vostio_metadata?:
33338
+ | {
33339
+ override_guest_acs_entrance_ids?:
33340
+ | string[]
33341
+ | undefined
33342
+ key_id?: string | undefined
33343
+ key_issuing_request_id?: string | undefined
33344
+ door_names?: string[] | undefined
33345
+ endpoint_id?: string | undefined
33346
+ }
33347
+ | undefined
33348
+ is_managed: true
33349
+ }
33350
+ | {
33351
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33352
+ acs_credential_id: string
33353
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
33354
+ acs_user_id?: string | undefined
33355
+ acs_credential_pool_id?: string | undefined
33356
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33357
+ acs_system_id: string
33358
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33359
+ parent_acs_credential_id?: string | undefined
33360
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33361
+ display_name: string
33362
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33363
+ code?: (string | undefined) | null
33364
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
33365
+ is_one_time_use?: boolean | undefined
33366
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33367
+ card_number?: (string | undefined) | null
33368
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
33369
+ is_issued?: boolean | undefined
33370
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
33371
+ issued_at?: (string | undefined) | null
33372
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
33373
+ access_method: 'code' | 'card' | 'mobile_key'
33374
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
33375
+ external_type?:
33376
+ | (
33377
+ | 'pti_card'
33378
+ | 'brivo_credential'
33379
+ | 'hid_credential'
33380
+ | 'visionline_card'
33381
+ | 'salto_ks_credential'
33382
+ | 'assa_abloy_vostio_key'
33383
+ | 'salto_space_key'
33384
+ )
33385
+ | undefined
33386
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33387
+ external_type_display_name?: string | undefined
33388
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
33389
+ created_at: string
33390
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33391
+ workspace_id: string
33392
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
33393
+ starts_at?: string | undefined
33394
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
33395
+ ends_at?: string | undefined
33396
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33397
+ errors: Array<{
33398
+ error_code: string
33399
+ message: string
33400
+ }>
33401
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33402
+ warnings: Array<
33403
+ | {
33404
+ /** Date and time at which Seam created the warning. */
33405
+ created_at: string
33406
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33407
+ message: string
33408
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33409
+ warning_code: 'waiting_to_be_issued'
33410
+ }
33411
+ | {
33412
+ /** Date and time at which Seam created the warning. */
33413
+ created_at: string
33414
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33415
+ message: string
33416
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33417
+ warning_code: 'schedule_externally_modified'
33418
+ }
33419
+ | {
33420
+ /** Date and time at which Seam created the warning. */
33421
+ created_at: string
33422
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33423
+ message: string
33424
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33425
+ warning_code: 'schedule_modified'
33426
+ }
33427
+ | {
33428
+ /** Date and time at which Seam created the warning. */
33429
+ created_at: string
33430
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33431
+ message: string
33432
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33433
+ warning_code: 'being_deleted'
33434
+ }
33435
+ | {
33436
+ /** Date and time at which Seam created the warning. */
33437
+ created_at: string
33438
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33439
+ message: string
33440
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33441
+ warning_code: 'unknown_issue_with_acs_credential'
33442
+ }
33443
+ | {
33444
+ /** Date and time at which Seam created the warning. */
33445
+ created_at: string
33446
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33447
+ message: string
33448
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33449
+ warning_code: 'needs_to_be_reissued'
33450
+ }
33451
+ >
33452
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
33453
+ is_multi_phone_sync_credential?: boolean | undefined
33454
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
33455
+ is_latest_desired_state_synced_with_provider?:
33456
+ | (boolean | null)
33457
+ | undefined
33458
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
33459
+ latest_desired_state_synced_with_provider_at?:
33460
+ | (string | null)
33461
+ | undefined
33462
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33463
+ visionline_metadata?:
33464
+ | {
33465
+ card_function_type: 'guest' | 'staff'
33466
+ joiner_acs_credential_ids?: string[] | undefined
33467
+ guest_acs_entrance_ids?: string[] | undefined
33468
+ common_acs_entrance_ids?: string[] | undefined
33469
+ is_valid?: boolean | undefined
33470
+ auto_join?: boolean | undefined
33471
+ card_id?: string | undefined
33472
+ credential_id?: string | undefined
33473
+ }
33474
+ | undefined
33475
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33476
+ assa_abloy_vostio_metadata?:
33477
+ | {
33478
+ override_guest_acs_entrance_ids?:
33479
+ | string[]
33480
+ | undefined
33481
+ key_id?: string | undefined
33482
+ key_issuing_request_id?: string | undefined
33483
+ door_names?: string[] | undefined
33484
+ endpoint_id?: string | undefined
33485
+ }
33486
+ | undefined
33487
+ is_managed: false
33488
+ }
33489
+ )
33490
+ | null
33491
+ warnings: Array<{
33492
+ warning_code:
33493
+ | 'acs_credential_on_encoder_out_of_sync'
33494
+ | 'acs_credential_on_seam_not_found'
33495
+ warning_message: string
33496
+ }>
33497
+ }
33498
+ }
33499
+ | {
33500
+ /** ID of the action attempt. */
33501
+ action_attempt_id: string
33502
+ status: 'error'
33503
+ /** Result of the action attempt. Null for failed action attempts. */
33504
+ result: null
33505
+ action_type: 'SCAN_CREDENTIAL'
33506
+ error:
33507
+ | {
33508
+ /** Type of the error associated with the action attempt. */
33509
+ type: 'uncategorized_error'
33510
+ /** Message for the error associated with the action attempt. */
33511
+ message: string
33512
+ }
33513
+ | {
33514
+ /** Type of the error associated with the action attempt. */
33515
+ type: 'action_attempt_expired'
33516
+ /** Message for the error associated with the action attempt. */
33517
+ message: string
33518
+ }
33519
+ | {
33520
+ type: 'no_credential_on_encoder'
33521
+ message: string
33522
+ }
33523
+ }
33524
+ | {
33525
+ /** ID of the action attempt. */
33526
+ action_attempt_id: string
33527
+ status: 'pending'
33528
+ /** Result of the action attempt. Null for pending action attempts. */
33529
+ result: null
33530
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33531
+ error: null
33532
+ /** Type of action that the action attempt tracks. */
33533
+ action_type: 'ENCODE_CREDENTIAL'
33534
+ }
33535
+ | {
33536
+ /** ID of the action attempt. */
33537
+ action_attempt_id: string
33538
+ status: 'success'
33539
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33540
+ error: null
33541
+ /** Type of action that the action attempt tracks. */
33542
+ action_type: 'ENCODE_CREDENTIAL'
33543
+ /** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
33544
+ result:
33545
+ | {
33546
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33547
+ acs_credential_id: string
33548
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
33549
+ acs_user_id?: string | undefined
33550
+ acs_credential_pool_id?: string | undefined
33551
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33552
+ acs_system_id: string
33553
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33554
+ parent_acs_credential_id?: string | undefined
33555
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33556
+ display_name: string
33557
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33558
+ code?: (string | undefined) | null
33559
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
33560
+ is_one_time_use?: boolean | undefined
33561
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33562
+ card_number?: (string | undefined) | null
33563
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
33564
+ is_issued?: boolean | undefined
33565
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
33566
+ issued_at?: (string | undefined) | null
33567
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
33568
+ access_method: 'code' | 'card' | 'mobile_key'
33569
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
33570
+ external_type?:
33571
+ | (
33572
+ | 'pti_card'
33573
+ | 'brivo_credential'
33574
+ | 'hid_credential'
33575
+ | 'visionline_card'
33576
+ | 'salto_ks_credential'
33577
+ | 'assa_abloy_vostio_key'
33578
+ | 'salto_space_key'
33579
+ )
33580
+ | undefined
33581
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33582
+ external_type_display_name?: string | undefined
33583
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
33584
+ created_at: string
33585
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33586
+ workspace_id: string
33587
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
33588
+ starts_at?: string | undefined
33589
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
33590
+ ends_at?: string | undefined
33591
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33592
+ errors: Array<{
33593
+ error_code: string
33594
+ message: string
33595
+ }>
33596
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33597
+ warnings: Array<
33598
+ | {
33599
+ /** Date and time at which Seam created the warning. */
33600
+ created_at: string
33601
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33602
+ message: string
33603
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33604
+ warning_code: 'waiting_to_be_issued'
33605
+ }
33606
+ | {
33607
+ /** Date and time at which Seam created the warning. */
33608
+ created_at: string
33609
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33610
+ message: string
33611
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33612
+ warning_code: 'schedule_externally_modified'
33613
+ }
33614
+ | {
33615
+ /** Date and time at which Seam created the warning. */
33616
+ created_at: string
33617
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33618
+ message: string
33619
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33620
+ warning_code: 'schedule_modified'
33621
+ }
33622
+ | {
33623
+ /** Date and time at which Seam created the warning. */
33624
+ created_at: string
33625
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33626
+ message: string
33627
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33628
+ warning_code: 'being_deleted'
33629
+ }
33630
+ | {
33631
+ /** Date and time at which Seam created the warning. */
33632
+ created_at: string
33633
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33634
+ message: string
33635
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33636
+ warning_code: 'unknown_issue_with_acs_credential'
33637
+ }
33638
+ | {
33639
+ /** Date and time at which Seam created the warning. */
33640
+ created_at: string
33641
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33642
+ message: string
33643
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33644
+ warning_code: 'needs_to_be_reissued'
33645
+ }
33646
+ >
33647
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
33648
+ is_multi_phone_sync_credential?: boolean | undefined
33649
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
33650
+ is_latest_desired_state_synced_with_provider?:
33651
+ | (boolean | null)
33652
+ | undefined
33653
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
33654
+ latest_desired_state_synced_with_provider_at?:
33655
+ | (string | null)
33656
+ | undefined
33657
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33658
+ visionline_metadata?:
33659
+ | {
33660
+ card_function_type: 'guest' | 'staff'
33661
+ joiner_acs_credential_ids?: string[] | undefined
33662
+ guest_acs_entrance_ids?: string[] | undefined
33663
+ common_acs_entrance_ids?: string[] | undefined
33664
+ is_valid?: boolean | undefined
33665
+ auto_join?: boolean | undefined
33666
+ card_id?: string | undefined
33667
+ credential_id?: string | undefined
33668
+ }
33669
+ | undefined
33670
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33671
+ assa_abloy_vostio_metadata?:
33672
+ | {
33673
+ override_guest_acs_entrance_ids?: string[] | undefined
33674
+ key_id?: string | undefined
33675
+ key_issuing_request_id?: string | undefined
33676
+ door_names?: string[] | undefined
33677
+ endpoint_id?: string | undefined
33678
+ }
33679
+ | undefined
33680
+ is_managed: true
33681
+ }
33682
+ | {
33683
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33684
+ acs_credential_id: string
33685
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
33686
+ acs_user_id?: string | undefined
33687
+ acs_credential_pool_id?: string | undefined
33688
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33689
+ acs_system_id: string
33690
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33691
+ parent_acs_credential_id?: string | undefined
33692
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33693
+ display_name: string
33694
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33695
+ code?: (string | undefined) | null
33696
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
33697
+ is_one_time_use?: boolean | undefined
33698
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33699
+ card_number?: (string | undefined) | null
33700
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
33701
+ is_issued?: boolean | undefined
33702
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
33703
+ issued_at?: (string | undefined) | null
33704
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
33705
+ access_method: 'code' | 'card' | 'mobile_key'
33706
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
33707
+ external_type?:
33708
+ | (
33709
+ | 'pti_card'
33710
+ | 'brivo_credential'
33711
+ | 'hid_credential'
33712
+ | 'visionline_card'
33713
+ | 'salto_ks_credential'
33714
+ | 'assa_abloy_vostio_key'
33715
+ | 'salto_space_key'
33716
+ )
33717
+ | undefined
33718
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
33719
+ external_type_display_name?: string | undefined
33720
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
33721
+ created_at: string
33722
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33723
+ workspace_id: string
33724
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
33725
+ starts_at?: string | undefined
33726
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
33727
+ ends_at?: string | undefined
33728
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33729
+ errors: Array<{
33730
+ error_code: string
33731
+ message: string
33732
+ }>
33733
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33734
+ warnings: Array<
33735
+ | {
33736
+ /** Date and time at which Seam created the warning. */
33737
+ created_at: string
33738
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33739
+ message: string
33740
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33741
+ warning_code: 'waiting_to_be_issued'
33742
+ }
33743
+ | {
33744
+ /** Date and time at which Seam created the warning. */
33745
+ created_at: string
33746
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33747
+ message: string
33748
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33749
+ warning_code: 'schedule_externally_modified'
33750
+ }
33751
+ | {
33752
+ /** Date and time at which Seam created the warning. */
33753
+ created_at: string
33754
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33755
+ message: string
33756
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33757
+ warning_code: 'schedule_modified'
33758
+ }
33759
+ | {
33760
+ /** Date and time at which Seam created the warning. */
33761
+ created_at: string
33762
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33763
+ message: string
33764
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33765
+ warning_code: 'being_deleted'
33766
+ }
33767
+ | {
33768
+ /** Date and time at which Seam created the warning. */
33769
+ created_at: string
33770
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33771
+ message: string
33772
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33773
+ warning_code: 'unknown_issue_with_acs_credential'
33774
+ }
33775
+ | {
33776
+ /** Date and time at which Seam created the warning. */
33777
+ created_at: string
33778
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
33779
+ message: string
33780
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
33781
+ warning_code: 'needs_to_be_reissued'
33782
+ }
33783
+ >
33784
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
33785
+ is_multi_phone_sync_credential?: boolean | undefined
33786
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
33787
+ is_latest_desired_state_synced_with_provider?:
33788
+ | (boolean | null)
33789
+ | undefined
33790
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
33791
+ latest_desired_state_synced_with_provider_at?:
33792
+ | (string | null)
33793
+ | undefined
33794
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33795
+ visionline_metadata?:
33796
+ | {
33797
+ card_function_type: 'guest' | 'staff'
33798
+ joiner_acs_credential_ids?: string[] | undefined
33799
+ guest_acs_entrance_ids?: string[] | undefined
33800
+ common_acs_entrance_ids?: string[] | undefined
33801
+ is_valid?: boolean | undefined
33802
+ auto_join?: boolean | undefined
33803
+ card_id?: string | undefined
33804
+ credential_id?: string | undefined
33805
+ }
33806
+ | undefined
33807
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
33808
+ assa_abloy_vostio_metadata?:
33809
+ | {
33810
+ override_guest_acs_entrance_ids?: string[] | undefined
33811
+ key_id?: string | undefined
33812
+ key_issuing_request_id?: string | undefined
33813
+ door_names?: string[] | undefined
33814
+ endpoint_id?: string | undefined
33815
+ }
33816
+ | undefined
33817
+ is_managed: false
33818
+ }
33819
+ }
33820
+ | {
33821
+ /** ID of the action attempt. */
33822
+ action_attempt_id: string
33823
+ status: 'error'
33824
+ /** Result of the action attempt. Null for failed action attempts. */
33825
+ result: null
33826
+ /** Type of action that the action attempt tracks. */
33827
+ action_type: 'ENCODE_CREDENTIAL'
33828
+ error:
33829
+ | {
33830
+ /** Type of the error associated with the action attempt. */
33831
+ type: 'uncategorized_error'
33832
+ /** Message for the error associated with the action attempt. */
33833
+ message: string
33834
+ }
33835
+ | {
33836
+ /** Type of the error associated with the action attempt. */
33837
+ type: 'action_attempt_expired'
33838
+ /** Message for the error associated with the action attempt. */
33839
+ message: string
33840
+ }
33841
+ | {
33842
+ type: 'no_credential_on_encoder'
33843
+ message: string
33844
+ }
33845
+ | {
33846
+ type: 'incompatible_card_format'
33847
+ message: string
33848
+ }
33849
+ | {
33850
+ type: 'credential_cannot_be_reissued'
33851
+ message: string
33852
+ }
33853
+ }
33854
+ | {
33855
+ /** ID of the action attempt. */
33856
+ action_attempt_id: string
33857
+ status: 'pending'
33858
+ /** Result of the action attempt. Null for pending action attempts. */
33859
+ result: null
33860
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33861
+ error: null
33862
+ action_type: 'RESET_SANDBOX_WORKSPACE'
33863
+ }
33864
+ | {
33865
+ /** ID of the action attempt. */
33866
+ action_attempt_id: string
33867
+ status: 'success'
33868
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33869
+ error: null
33870
+ action_type: 'RESET_SANDBOX_WORKSPACE'
33871
+ result: {}
33872
+ }
33873
+ | {
33874
+ /** ID of the action attempt. */
33875
+ action_attempt_id: string
33876
+ status: 'error'
33877
+ /** Result of the action attempt. Null for failed action attempts. */
33878
+ result: null
33879
+ action_type: 'RESET_SANDBOX_WORKSPACE'
33880
+ error: {
33881
+ type: string
33882
+ message: string
33883
+ }
33884
+ }
33885
+ | {
33886
+ /** ID of the action attempt. */
33887
+ action_attempt_id: string
33888
+ status: 'pending'
33889
+ /** Result of the action attempt. Null for pending action attempts. */
33890
+ result: null
33891
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33892
+ error: null
33893
+ action_type: 'SET_FAN_MODE'
33894
+ }
33895
+ | {
33896
+ /** ID of the action attempt. */
33897
+ action_attempt_id: string
33898
+ status: 'success'
33899
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33900
+ error: null
33901
+ action_type: 'SET_FAN_MODE'
33902
+ result: {}
33903
+ }
33904
+ | {
33905
+ /** ID of the action attempt. */
33906
+ action_attempt_id: string
33907
+ status: 'error'
33908
+ /** Result of the action attempt. Null for failed action attempts. */
33909
+ result: null
33910
+ action_type: 'SET_FAN_MODE'
33911
+ error: {
33912
+ type: string
33913
+ message: string
33914
+ }
33915
+ }
33916
+ | {
33917
+ /** ID of the action attempt. */
33918
+ action_attempt_id: string
33919
+ status: 'pending'
33920
+ /** Result of the action attempt. Null for pending action attempts. */
33921
+ result: null
33922
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33923
+ error: null
33924
+ action_type: 'SET_HVAC_MODE'
33925
+ }
33926
+ | {
33927
+ /** ID of the action attempt. */
33928
+ action_attempt_id: string
33929
+ status: 'success'
33930
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33931
+ error: null
33932
+ action_type: 'SET_HVAC_MODE'
33933
+ result: {}
33934
+ }
33935
+ | {
33936
+ /** ID of the action attempt. */
33937
+ action_attempt_id: string
33938
+ status: 'error'
33939
+ /** Result of the action attempt. Null for failed action attempts. */
33940
+ result: null
33941
+ action_type: 'SET_HVAC_MODE'
33942
+ error: {
33943
+ type: string
33944
+ message: string
33945
+ }
33946
+ }
33947
+ | {
33948
+ /** ID of the action attempt. */
33949
+ action_attempt_id: string
33950
+ status: 'pending'
33951
+ /** Result of the action attempt. Null for pending action attempts. */
33952
+ result: null
33953
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33954
+ error: null
33955
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
33956
+ }
33957
+ | {
33958
+ /** ID of the action attempt. */
33959
+ action_attempt_id: string
33960
+ status: 'success'
33961
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33962
+ error: null
33963
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
33964
+ result: {}
33965
+ }
33966
+ | {
33967
+ /** ID of the action attempt. */
33968
+ action_attempt_id: string
33969
+ status: 'error'
33970
+ /** Result of the action attempt. Null for failed action attempts. */
33971
+ result: null
33972
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
33973
+ error: {
33974
+ type: string
33975
+ message: string
33976
+ }
33977
+ }
33978
+ | {
33979
+ /** ID of the action attempt. */
33980
+ action_attempt_id: string
33981
+ status: 'pending'
33982
+ /** Result of the action attempt. Null for pending action attempts. */
33983
+ result: null
33984
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33985
+ error: null
33986
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
33987
+ }
33988
+ | {
33989
+ /** ID of the action attempt. */
33990
+ action_attempt_id: string
33991
+ status: 'success'
33992
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33993
+ error: null
33994
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
33995
+ result: {}
33996
+ }
33997
+ | {
33998
+ /** ID of the action attempt. */
33999
+ action_attempt_id: string
34000
+ status: 'error'
34001
+ /** Result of the action attempt. Null for failed action attempts. */
34002
+ result: null
34003
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
34004
+ error: {
34005
+ type: string
34006
+ message: string
34007
+ }
34008
+ }
34009
+ | {
34010
+ /** ID of the action attempt. */
34011
+ action_attempt_id: string
34012
+ status: 'pending'
34013
+ /** Result of the action attempt. Null for pending action attempts. */
34014
+ result: null
34015
+ /** Errors associated with the action attempt. Null for pending action attempts. */
34016
+ error: null
34017
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
34018
+ }
34019
+ | {
34020
+ /** ID of the action attempt. */
34021
+ action_attempt_id: string
34022
+ status: 'success'
34023
+ /** Errors associated with the action attempt. Null for successful action attempts. */
34024
+ error: null
34025
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
34026
+ result: {}
34027
+ }
34028
+ | {
34029
+ /** ID of the action attempt. */
34030
+ action_attempt_id: string
34031
+ status: 'error'
34032
+ /** Result of the action attempt. Null for failed action attempts. */
34033
+ result: null
34034
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
34035
+ error: {
34036
+ type: string
34037
+ message: string
34038
+ }
34039
+ }
31059
34040
  | {
31060
34041
  /** ID of the action attempt. */
31061
34042
  action_attempt_id: string
@@ -34146,6 +37127,68 @@ export interface Routes {
34146
37127
  message: string
34147
37128
  }
34148
37129
  }
37130
+ | {
37131
+ /** ID of the action attempt. */
37132
+ action_attempt_id: string
37133
+ status: 'pending'
37134
+ /** Result of the action attempt. Null for pending action attempts. */
37135
+ result: null
37136
+ /** Errors associated with the action attempt. Null for pending action attempts. */
37137
+ error: null
37138
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
37139
+ }
37140
+ | {
37141
+ /** ID of the action attempt. */
37142
+ action_attempt_id: string
37143
+ status: 'success'
37144
+ /** Errors associated with the action attempt. Null for successful action attempts. */
37145
+ error: null
37146
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
37147
+ result: {}
37148
+ }
37149
+ | {
37150
+ /** ID of the action attempt. */
37151
+ action_attempt_id: string
37152
+ status: 'error'
37153
+ /** Result of the action attempt. Null for failed action attempts. */
37154
+ result: null
37155
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
37156
+ error: {
37157
+ type: string
37158
+ message: string
37159
+ }
37160
+ }
37161
+ | {
37162
+ /** ID of the action attempt. */
37163
+ action_attempt_id: string
37164
+ status: 'pending'
37165
+ /** Result of the action attempt. Null for pending action attempts. */
37166
+ result: null
37167
+ /** Errors associated with the action attempt. Null for pending action attempts. */
37168
+ error: null
37169
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
37170
+ }
37171
+ | {
37172
+ /** ID of the action attempt. */
37173
+ action_attempt_id: string
37174
+ status: 'success'
37175
+ /** Errors associated with the action attempt. Null for successful action attempts. */
37176
+ error: null
37177
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
37178
+ result: {}
37179
+ }
37180
+ | {
37181
+ /** ID of the action attempt. */
37182
+ action_attempt_id: string
37183
+ status: 'error'
37184
+ /** Result of the action attempt. Null for failed action attempts. */
37185
+ result: null
37186
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
37187
+ error: {
37188
+ type: string
37189
+ message: string
37190
+ }
37191
+ }
34149
37192
  | {
34150
37193
  /** ID of the action attempt. */
34151
37194
  action_attempt_id: string
@@ -35288,6 +38331,68 @@ export interface Routes {
35288
38331
  message: string
35289
38332
  }
35290
38333
  }
38334
+ | {
38335
+ /** ID of the action attempt. */
38336
+ action_attempt_id: string
38337
+ status: 'pending'
38338
+ /** Result of the action attempt. Null for pending action attempts. */
38339
+ result: null
38340
+ /** Errors associated with the action attempt. Null for pending action attempts. */
38341
+ error: null
38342
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
38343
+ }
38344
+ | {
38345
+ /** ID of the action attempt. */
38346
+ action_attempt_id: string
38347
+ status: 'success'
38348
+ /** Errors associated with the action attempt. Null for successful action attempts. */
38349
+ error: null
38350
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
38351
+ result: {}
38352
+ }
38353
+ | {
38354
+ /** ID of the action attempt. */
38355
+ action_attempt_id: string
38356
+ status: 'error'
38357
+ /** Result of the action attempt. Null for failed action attempts. */
38358
+ result: null
38359
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
38360
+ error: {
38361
+ type: string
38362
+ message: string
38363
+ }
38364
+ }
38365
+ | {
38366
+ /** ID of the action attempt. */
38367
+ action_attempt_id: string
38368
+ status: 'pending'
38369
+ /** Result of the action attempt. Null for pending action attempts. */
38370
+ result: null
38371
+ /** Errors associated with the action attempt. Null for pending action attempts. */
38372
+ error: null
38373
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
38374
+ }
38375
+ | {
38376
+ /** ID of the action attempt. */
38377
+ action_attempt_id: string
38378
+ status: 'success'
38379
+ /** Errors associated with the action attempt. Null for successful action attempts. */
38380
+ error: null
38381
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
38382
+ result: {}
38383
+ }
38384
+ | {
38385
+ /** ID of the action attempt. */
38386
+ action_attempt_id: string
38387
+ status: 'error'
38388
+ /** Result of the action attempt. Null for failed action attempts. */
38389
+ result: null
38390
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
38391
+ error: {
38392
+ type: string
38393
+ message: string
38394
+ }
38395
+ }
35291
38396
  | {
35292
38397
  /** ID of the action attempt. */
35293
38398
  action_attempt_id: string
@@ -36469,6 +39574,68 @@ export interface Routes {
36469
39574
  message: string
36470
39575
  }
36471
39576
  }
39577
+ | {
39578
+ /** ID of the action attempt. */
39579
+ action_attempt_id: string
39580
+ status: 'pending'
39581
+ /** Result of the action attempt. Null for pending action attempts. */
39582
+ result: null
39583
+ /** Errors associated with the action attempt. Null for pending action attempts. */
39584
+ error: null
39585
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
39586
+ }
39587
+ | {
39588
+ /** ID of the action attempt. */
39589
+ action_attempt_id: string
39590
+ status: 'success'
39591
+ /** Errors associated with the action attempt. Null for successful action attempts. */
39592
+ error: null
39593
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
39594
+ result: {}
39595
+ }
39596
+ | {
39597
+ /** ID of the action attempt. */
39598
+ action_attempt_id: string
39599
+ status: 'error'
39600
+ /** Result of the action attempt. Null for failed action attempts. */
39601
+ result: null
39602
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
39603
+ error: {
39604
+ type: string
39605
+ message: string
39606
+ }
39607
+ }
39608
+ | {
39609
+ /** ID of the action attempt. */
39610
+ action_attempt_id: string
39611
+ status: 'pending'
39612
+ /** Result of the action attempt. Null for pending action attempts. */
39613
+ result: null
39614
+ /** Errors associated with the action attempt. Null for pending action attempts. */
39615
+ error: null
39616
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
39617
+ }
39618
+ | {
39619
+ /** ID of the action attempt. */
39620
+ action_attempt_id: string
39621
+ status: 'success'
39622
+ /** Errors associated with the action attempt. Null for successful action attempts. */
39623
+ error: null
39624
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
39625
+ result: {}
39626
+ }
39627
+ | {
39628
+ /** ID of the action attempt. */
39629
+ action_attempt_id: string
39630
+ status: 'error'
39631
+ /** Result of the action attempt. Null for failed action attempts. */
39632
+ result: null
39633
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
39634
+ error: {
39635
+ type: string
39636
+ message: string
39637
+ }
39638
+ }
36472
39639
  | {
36473
39640
  /** ID of the action attempt. */
36474
39641
  action_attempt_id: string
@@ -37176,6 +40343,32 @@ export interface Routes {
37176
40343
  }>
37177
40344
  }
37178
40345
  }
40346
+ '/seam/instant_key/v1/client_sessions/exchange_short_code': {
40347
+ route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
40348
+ method: 'POST'
40349
+ queryParams: {}
40350
+ jsonBody: {
40351
+ /** The short code to exchange for a client session token */
40352
+ short_code: string
40353
+ }
40354
+ commonParams: {}
40355
+ formData: {}
40356
+ jsonResponse: {
40357
+ /** */
40358
+ client_session: {
40359
+ client_session_id: string
40360
+ workspace_id: string
40361
+ created_at: string
40362
+ expires_at: string
40363
+ token: string
40364
+ user_identifier_key: string | null
40365
+ device_count: number
40366
+ connected_account_ids: string[]
40367
+ connect_webview_ids: string[]
40368
+ user_identity_ids: string[]
40369
+ }
40370
+ }
40371
+ }
37179
40372
  '/thermostats/activate_climate_preset': {
37180
40373
  route: '/thermostats/activate_climate_preset'
37181
40374
  method: 'POST'
@@ -38082,6 +41275,68 @@ export interface Routes {
38082
41275
  message: string
38083
41276
  }
38084
41277
  }
41278
+ | {
41279
+ /** ID of the action attempt. */
41280
+ action_attempt_id: string
41281
+ status: 'pending'
41282
+ /** Result of the action attempt. Null for pending action attempts. */
41283
+ result: null
41284
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41285
+ error: null
41286
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
41287
+ }
41288
+ | {
41289
+ /** ID of the action attempt. */
41290
+ action_attempt_id: string
41291
+ status: 'success'
41292
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41293
+ error: null
41294
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
41295
+ result: {}
41296
+ }
41297
+ | {
41298
+ /** ID of the action attempt. */
41299
+ action_attempt_id: string
41300
+ status: 'error'
41301
+ /** Result of the action attempt. Null for failed action attempts. */
41302
+ result: null
41303
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
41304
+ error: {
41305
+ type: string
41306
+ message: string
41307
+ }
41308
+ }
41309
+ | {
41310
+ /** ID of the action attempt. */
41311
+ action_attempt_id: string
41312
+ status: 'pending'
41313
+ /** Result of the action attempt. Null for pending action attempts. */
41314
+ result: null
41315
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41316
+ error: null
41317
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
41318
+ }
41319
+ | {
41320
+ /** ID of the action attempt. */
41321
+ action_attempt_id: string
41322
+ status: 'success'
41323
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41324
+ error: null
41325
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
41326
+ result: {}
41327
+ }
41328
+ | {
41329
+ /** ID of the action attempt. */
41330
+ action_attempt_id: string
41331
+ status: 'error'
41332
+ /** Result of the action attempt. Null for failed action attempts. */
41333
+ result: null
41334
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
41335
+ error: {
41336
+ type: string
41337
+ message: string
41338
+ }
41339
+ }
38085
41340
  | {
38086
41341
  /** ID of the action attempt. */
38087
41342
  action_attempt_id: string
@@ -39219,6 +42474,68 @@ export interface Routes {
39219
42474
  message: string
39220
42475
  }
39221
42476
  }
42477
+ | {
42478
+ /** ID of the action attempt. */
42479
+ action_attempt_id: string
42480
+ status: 'pending'
42481
+ /** Result of the action attempt. Null for pending action attempts. */
42482
+ result: null
42483
+ /** Errors associated with the action attempt. Null for pending action attempts. */
42484
+ error: null
42485
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
42486
+ }
42487
+ | {
42488
+ /** ID of the action attempt. */
42489
+ action_attempt_id: string
42490
+ status: 'success'
42491
+ /** Errors associated with the action attempt. Null for successful action attempts. */
42492
+ error: null
42493
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
42494
+ result: {}
42495
+ }
42496
+ | {
42497
+ /** ID of the action attempt. */
42498
+ action_attempt_id: string
42499
+ status: 'error'
42500
+ /** Result of the action attempt. Null for failed action attempts. */
42501
+ result: null
42502
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
42503
+ error: {
42504
+ type: string
42505
+ message: string
42506
+ }
42507
+ }
42508
+ | {
42509
+ /** ID of the action attempt. */
42510
+ action_attempt_id: string
42511
+ status: 'pending'
42512
+ /** Result of the action attempt. Null for pending action attempts. */
42513
+ result: null
42514
+ /** Errors associated with the action attempt. Null for pending action attempts. */
42515
+ error: null
42516
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
42517
+ }
42518
+ | {
42519
+ /** ID of the action attempt. */
42520
+ action_attempt_id: string
42521
+ status: 'success'
42522
+ /** Errors associated with the action attempt. Null for successful action attempts. */
42523
+ error: null
42524
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
42525
+ result: {}
42526
+ }
42527
+ | {
42528
+ /** ID of the action attempt. */
42529
+ action_attempt_id: string
42530
+ status: 'error'
42531
+ /** Result of the action attempt. Null for failed action attempts. */
42532
+ result: null
42533
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
42534
+ error: {
42535
+ type: string
42536
+ message: string
42537
+ }
42538
+ }
39222
42539
  | {
39223
42540
  /** ID of the action attempt. */
39224
42541
  action_attempt_id: string
@@ -41342,6 +44659,68 @@ export interface Routes {
41342
44659
  message: string
41343
44660
  }
41344
44661
  }
44662
+ | {
44663
+ /** ID of the action attempt. */
44664
+ action_attempt_id: string
44665
+ status: 'pending'
44666
+ /** Result of the action attempt. Null for pending action attempts. */
44667
+ result: null
44668
+ /** Errors associated with the action attempt. Null for pending action attempts. */
44669
+ error: null
44670
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
44671
+ }
44672
+ | {
44673
+ /** ID of the action attempt. */
44674
+ action_attempt_id: string
44675
+ status: 'success'
44676
+ /** Errors associated with the action attempt. Null for successful action attempts. */
44677
+ error: null
44678
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
44679
+ result: {}
44680
+ }
44681
+ | {
44682
+ /** ID of the action attempt. */
44683
+ action_attempt_id: string
44684
+ status: 'error'
44685
+ /** Result of the action attempt. Null for failed action attempts. */
44686
+ result: null
44687
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
44688
+ error: {
44689
+ type: string
44690
+ message: string
44691
+ }
44692
+ }
44693
+ | {
44694
+ /** ID of the action attempt. */
44695
+ action_attempt_id: string
44696
+ status: 'pending'
44697
+ /** Result of the action attempt. Null for pending action attempts. */
44698
+ result: null
44699
+ /** Errors associated with the action attempt. Null for pending action attempts. */
44700
+ error: null
44701
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
44702
+ }
44703
+ | {
44704
+ /** ID of the action attempt. */
44705
+ action_attempt_id: string
44706
+ status: 'success'
44707
+ /** Errors associated with the action attempt. Null for successful action attempts. */
44708
+ error: null
44709
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
44710
+ result: {}
44711
+ }
44712
+ | {
44713
+ /** ID of the action attempt. */
44714
+ action_attempt_id: string
44715
+ status: 'error'
44716
+ /** Result of the action attempt. Null for failed action attempts. */
44717
+ result: null
44718
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
44719
+ error: {
44720
+ type: string
44721
+ message: string
44722
+ }
44723
+ }
41345
44724
  | {
41346
44725
  /** ID of the action attempt. */
41347
44726
  action_attempt_id: string
@@ -42483,6 +45862,68 @@ export interface Routes {
42483
45862
  message: string
42484
45863
  }
42485
45864
  }
45865
+ | {
45866
+ /** ID of the action attempt. */
45867
+ action_attempt_id: string
45868
+ status: 'pending'
45869
+ /** Result of the action attempt. Null for pending action attempts. */
45870
+ result: null
45871
+ /** Errors associated with the action attempt. Null for pending action attempts. */
45872
+ error: null
45873
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
45874
+ }
45875
+ | {
45876
+ /** ID of the action attempt. */
45877
+ action_attempt_id: string
45878
+ status: 'success'
45879
+ /** Errors associated with the action attempt. Null for successful action attempts. */
45880
+ error: null
45881
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
45882
+ result: {}
45883
+ }
45884
+ | {
45885
+ /** ID of the action attempt. */
45886
+ action_attempt_id: string
45887
+ status: 'error'
45888
+ /** Result of the action attempt. Null for failed action attempts. */
45889
+ result: null
45890
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
45891
+ error: {
45892
+ type: string
45893
+ message: string
45894
+ }
45895
+ }
45896
+ | {
45897
+ /** ID of the action attempt. */
45898
+ action_attempt_id: string
45899
+ status: 'pending'
45900
+ /** Result of the action attempt. Null for pending action attempts. */
45901
+ result: null
45902
+ /** Errors associated with the action attempt. Null for pending action attempts. */
45903
+ error: null
45904
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
45905
+ }
45906
+ | {
45907
+ /** ID of the action attempt. */
45908
+ action_attempt_id: string
45909
+ status: 'success'
45910
+ /** Errors associated with the action attempt. Null for successful action attempts. */
45911
+ error: null
45912
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
45913
+ result: {}
45914
+ }
45915
+ | {
45916
+ /** ID of the action attempt. */
45917
+ action_attempt_id: string
45918
+ status: 'error'
45919
+ /** Result of the action attempt. Null for failed action attempts. */
45920
+ result: null
45921
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
45922
+ error: {
45923
+ type: string
45924
+ message: string
45925
+ }
45926
+ }
42486
45927
  | {
42487
45928
  /** ID of the action attempt. */
42488
45929
  action_attempt_id: string
@@ -45551,6 +48992,68 @@ export interface Routes {
45551
48992
  message: string
45552
48993
  }
45553
48994
  }
48995
+ | {
48996
+ /** ID of the action attempt. */
48997
+ action_attempt_id: string
48998
+ status: 'pending'
48999
+ /** Result of the action attempt. Null for pending action attempts. */
49000
+ result: null
49001
+ /** Errors associated with the action attempt. Null for pending action attempts. */
49002
+ error: null
49003
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
49004
+ }
49005
+ | {
49006
+ /** ID of the action attempt. */
49007
+ action_attempt_id: string
49008
+ status: 'success'
49009
+ /** Errors associated with the action attempt. Null for successful action attempts. */
49010
+ error: null
49011
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
49012
+ result: {}
49013
+ }
49014
+ | {
49015
+ /** ID of the action attempt. */
49016
+ action_attempt_id: string
49017
+ status: 'error'
49018
+ /** Result of the action attempt. Null for failed action attempts. */
49019
+ result: null
49020
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
49021
+ error: {
49022
+ type: string
49023
+ message: string
49024
+ }
49025
+ }
49026
+ | {
49027
+ /** ID of the action attempt. */
49028
+ action_attempt_id: string
49029
+ status: 'pending'
49030
+ /** Result of the action attempt. Null for pending action attempts. */
49031
+ result: null
49032
+ /** Errors associated with the action attempt. Null for pending action attempts. */
49033
+ error: null
49034
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
49035
+ }
49036
+ | {
49037
+ /** ID of the action attempt. */
49038
+ action_attempt_id: string
49039
+ status: 'success'
49040
+ /** Errors associated with the action attempt. Null for successful action attempts. */
49041
+ error: null
49042
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
49043
+ result: {}
49044
+ }
49045
+ | {
49046
+ /** ID of the action attempt. */
49047
+ action_attempt_id: string
49048
+ status: 'error'
49049
+ /** Result of the action attempt. Null for failed action attempts. */
49050
+ result: null
49051
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
49052
+ error: {
49053
+ type: string
49054
+ message: string
49055
+ }
49056
+ }
45554
49057
  | {
45555
49058
  /** ID of the action attempt. */
45556
49059
  action_attempt_id: string
@@ -46874,6 +50377,68 @@ export interface Routes {
46874
50377
  message: string
46875
50378
  }
46876
50379
  }
50380
+ | {
50381
+ /** ID of the action attempt. */
50382
+ action_attempt_id: string
50383
+ status: 'pending'
50384
+ /** Result of the action attempt. Null for pending action attempts. */
50385
+ result: null
50386
+ /** Errors associated with the action attempt. Null for pending action attempts. */
50387
+ error: null
50388
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
50389
+ }
50390
+ | {
50391
+ /** ID of the action attempt. */
50392
+ action_attempt_id: string
50393
+ status: 'success'
50394
+ /** Errors associated with the action attempt. Null for successful action attempts. */
50395
+ error: null
50396
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
50397
+ result: {}
50398
+ }
50399
+ | {
50400
+ /** ID of the action attempt. */
50401
+ action_attempt_id: string
50402
+ status: 'error'
50403
+ /** Result of the action attempt. Null for failed action attempts. */
50404
+ result: null
50405
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
50406
+ error: {
50407
+ type: string
50408
+ message: string
50409
+ }
50410
+ }
50411
+ | {
50412
+ /** ID of the action attempt. */
50413
+ action_attempt_id: string
50414
+ status: 'pending'
50415
+ /** Result of the action attempt. Null for pending action attempts. */
50416
+ result: null
50417
+ /** Errors associated with the action attempt. Null for pending action attempts. */
50418
+ error: null
50419
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
50420
+ }
50421
+ | {
50422
+ /** ID of the action attempt. */
50423
+ action_attempt_id: string
50424
+ status: 'success'
50425
+ /** Errors associated with the action attempt. Null for successful action attempts. */
50426
+ error: null
50427
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
50428
+ result: {}
50429
+ }
50430
+ | {
50431
+ /** ID of the action attempt. */
50432
+ action_attempt_id: string
50433
+ status: 'error'
50434
+ /** Result of the action attempt. Null for failed action attempts. */
50435
+ result: null
50436
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
50437
+ error: {
50438
+ type: string
50439
+ message: string
50440
+ }
50441
+ }
46877
50442
  | {
46878
50443
  /** ID of the action attempt. */
46879
50444
  action_attempt_id: string
@@ -48038,6 +51603,68 @@ export interface Routes {
48038
51603
  message: string
48039
51604
  }
48040
51605
  }
51606
+ | {
51607
+ /** ID of the action attempt. */
51608
+ action_attempt_id: string
51609
+ status: 'pending'
51610
+ /** Result of the action attempt. Null for pending action attempts. */
51611
+ result: null
51612
+ /** Errors associated with the action attempt. Null for pending action attempts. */
51613
+ error: null
51614
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
51615
+ }
51616
+ | {
51617
+ /** ID of the action attempt. */
51618
+ action_attempt_id: string
51619
+ status: 'success'
51620
+ /** Errors associated with the action attempt. Null for successful action attempts. */
51621
+ error: null
51622
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
51623
+ result: {}
51624
+ }
51625
+ | {
51626
+ /** ID of the action attempt. */
51627
+ action_attempt_id: string
51628
+ status: 'error'
51629
+ /** Result of the action attempt. Null for failed action attempts. */
51630
+ result: null
51631
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
51632
+ error: {
51633
+ type: string
51634
+ message: string
51635
+ }
51636
+ }
51637
+ | {
51638
+ /** ID of the action attempt. */
51639
+ action_attempt_id: string
51640
+ status: 'pending'
51641
+ /** Result of the action attempt. Null for pending action attempts. */
51642
+ result: null
51643
+ /** Errors associated with the action attempt. Null for pending action attempts. */
51644
+ error: null
51645
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
51646
+ }
51647
+ | {
51648
+ /** ID of the action attempt. */
51649
+ action_attempt_id: string
51650
+ status: 'success'
51651
+ /** Errors associated with the action attempt. Null for successful action attempts. */
51652
+ error: null
51653
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
51654
+ result: {}
51655
+ }
51656
+ | {
51657
+ /** ID of the action attempt. */
51658
+ action_attempt_id: string
51659
+ status: 'error'
51660
+ /** Result of the action attempt. Null for failed action attempts. */
51661
+ result: null
51662
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
51663
+ error: {
51664
+ type: string
51665
+ message: string
51666
+ }
51667
+ }
48041
51668
  | {
48042
51669
  /** ID of the action attempt. */
48043
51670
  action_attempt_id: string
@@ -48407,13 +52034,15 @@ export interface Routes {
48407
52034
  /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
48408
52035
  location?:
48409
52036
  | {
52037
+ /** Name of the location. */
52038
+ name?: string | undefined
48410
52039
  /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to add to the location to which access is being granted. */
48411
52040
  acs_entrance_ids?: string[]
48412
52041
  /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted. */
48413
52042
  device_ids?: string[]
48414
52043
  }
48415
52044
  | undefined
48416
- desired_access_methods: Array<{
52045
+ requested_access_methods: Array<{
48417
52046
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
48418
52047
  mode: 'code' | 'card' | 'mobile_key'
48419
52048
  }>
@@ -48442,9 +52071,11 @@ export interface Routes {
48442
52071
  mode: 'code' | 'card' | 'mobile_key'
48443
52072
  /** Date and time at which the requested access method was added to this access grant. */
48444
52073
  created_at: string
48445
- /** IDs of the locations to which access is being given. */
48446
- provisioned_access_method_ids: string[]
52074
+ /** IDs of the access methods that were created for this requested access method. */
52075
+ created_access_method_ids: string[]
48447
52076
  }>
52077
+ /** IDs of the access methods that were created for this access grant. */
52078
+ access_method_ids: string[]
48448
52079
  /** Display name of the access grant. */
48449
52080
  display_name: string
48450
52081
  /** Date and time at which the access grant was created. */
@@ -48481,9 +52112,11 @@ export interface Routes {
48481
52112
  mode: 'code' | 'card' | 'mobile_key'
48482
52113
  /** Date and time at which the requested access method was added to this access grant. */
48483
52114
  created_at: string
48484
- /** IDs of the locations to which access is being given. */
48485
- provisioned_access_method_ids: string[]
52115
+ /** IDs of the access methods that were created for this requested access method. */
52116
+ created_access_method_ids: string[]
48486
52117
  }>
52118
+ /** IDs of the access methods that were created for this access grant. */
52119
+ access_method_ids: string[]
48487
52120
  /** Display name of the access grant. */
48488
52121
  display_name: string
48489
52122
  /** Date and time at which the access grant was created. */
@@ -48525,9 +52158,11 @@ export interface Routes {
48525
52158
  mode: 'code' | 'card' | 'mobile_key'
48526
52159
  /** Date and time at which the requested access method was added to this access grant. */
48527
52160
  created_at: string
48528
- /** IDs of the locations to which access is being given. */
48529
- provisioned_access_method_ids: string[]
52161
+ /** IDs of the access methods that were created for this requested access method. */
52162
+ created_access_method_ids: string[]
48530
52163
  }>
52164
+ /** IDs of the access methods that were created for this access grant. */
52165
+ access_method_ids: string[]
48531
52166
  /** Display name of the access grant. */
48532
52167
  display_name: string
48533
52168
  /** Date and time at which the access grant was created. */
@@ -48535,8 +52170,8 @@ export interface Routes {
48535
52170
  }>
48536
52171
  }
48537
52172
  }
48538
- '/unstable_access_grants/list_access_methods': {
48539
- route: '/unstable_access_grants/list_access_methods'
52173
+ '/unstable_access_methods/list': {
52174
+ route: '/unstable_access_methods/list'
48540
52175
  method: 'GET' | 'POST'
48541
52176
  queryParams: {}
48542
52177
  jsonBody: {}
@@ -48904,6 +52539,8 @@ export interface Routes {
48904
52539
  commonParams: {
48905
52540
  /** ID of the user identity for which you want to generate an instant key. */
48906
52541
  user_identity_id: string
52542
+ /** The maximum number of times the instant key can be used. Defaults to 1. */
52543
+ max_use_count?: number
48907
52544
  }
48908
52545
  formData: {}
48909
52546
  jsonResponse: {
@@ -51384,10 +55021,26 @@ export interface Routes {
51384
55021
  * @deprecated use company_name */
51385
55022
  connect_partner_name?: ((string | null) | null) | undefined
51386
55023
  is_sandbox?: boolean
55024
+ /**
55025
+ * @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
51387
55026
  webview_primary_button_color?: string | undefined
55027
+ /**
55028
+ * @deprecated Use `connect_webview_customization.webview_primary_button_text_color` instead. */
51388
55029
  webview_primary_button_text_color?: string | undefined
55030
+ /**
55031
+ * @deprecated Use `connect_webview_customization.webview_logo_shape` instead. */
51389
55032
  webview_logo_shape?: ('circle' | 'square') | undefined
55033
+ /**
55034
+ * @deprecated Use `connect_webview_customization.webview_success_message` instead. */
51390
55035
  webview_success_message?: string | undefined
55036
+ connect_webview_customization?:
55037
+ | {
55038
+ primary_button_color?: (string | null) | undefined
55039
+ primary_button_text_color?: (string | null) | undefined
55040
+ success_message?: (string | null) | undefined
55041
+ logo_shape?: (('circle' | 'square') | null) | undefined
55042
+ }
55043
+ | undefined
51391
55044
  }
51392
55045
  commonParams: {}
51393
55046
  formData: {}
@@ -51398,6 +55051,13 @@ export interface Routes {
51398
55051
  name: string
51399
55052
  company_name: string
51400
55053
  is_sandbox: boolean
55054
+ connect_webview_customization: {
55055
+ primary_button_color?: string | undefined
55056
+ primary_button_text_color?: string | undefined
55057
+ success_message?: string | undefined
55058
+ logo_shape?: ('circle' | 'square') | undefined
55059
+ inviter_logo_url?: string | undefined
55060
+ }
51401
55061
  /** True if a sandbox workspace has not been accessed in 14 days */
51402
55062
  is_suspended: boolean
51403
55063
  /**
@@ -51420,6 +55080,13 @@ export interface Routes {
51420
55080
  name: string
51421
55081
  company_name: string
51422
55082
  is_sandbox: boolean
55083
+ connect_webview_customization: {
55084
+ primary_button_color?: string | undefined
55085
+ primary_button_text_color?: string | undefined
55086
+ success_message?: string | undefined
55087
+ logo_shape?: ('circle' | 'square') | undefined
55088
+ inviter_logo_url?: string | undefined
55089
+ }
51423
55090
  /** True if a sandbox workspace has not been accessed in 14 days */
51424
55091
  is_suspended: boolean
51425
55092
  /**
@@ -51441,6 +55108,13 @@ export interface Routes {
51441
55108
  name: string
51442
55109
  company_name: string
51443
55110
  is_sandbox: boolean
55111
+ connect_webview_customization: {
55112
+ primary_button_color?: string | undefined
55113
+ primary_button_text_color?: string | undefined
55114
+ success_message?: string | undefined
55115
+ logo_shape?: ('circle' | 'square') | undefined
55116
+ inviter_logo_url?: string | undefined
55117
+ }
51444
55118
  /** True if a sandbox workspace has not been accessed in 14 days */
51445
55119
  is_suspended: boolean
51446
55120
  /**
@@ -52350,6 +56024,68 @@ export interface Routes {
52350
56024
  message: string
52351
56025
  }
52352
56026
  }
56027
+ | {
56028
+ /** ID of the action attempt. */
56029
+ action_attempt_id: string
56030
+ status: 'pending'
56031
+ /** Result of the action attempt. Null for pending action attempts. */
56032
+ result: null
56033
+ /** Errors associated with the action attempt. Null for pending action attempts. */
56034
+ error: null
56035
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
56036
+ }
56037
+ | {
56038
+ /** ID of the action attempt. */
56039
+ action_attempt_id: string
56040
+ status: 'success'
56041
+ /** Errors associated with the action attempt. Null for successful action attempts. */
56042
+ error: null
56043
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
56044
+ result: {}
56045
+ }
56046
+ | {
56047
+ /** ID of the action attempt. */
56048
+ action_attempt_id: string
56049
+ status: 'error'
56050
+ /** Result of the action attempt. Null for failed action attempts. */
56051
+ result: null
56052
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
56053
+ error: {
56054
+ type: string
56055
+ message: string
56056
+ }
56057
+ }
56058
+ | {
56059
+ /** ID of the action attempt. */
56060
+ action_attempt_id: string
56061
+ status: 'pending'
56062
+ /** Result of the action attempt. Null for pending action attempts. */
56063
+ result: null
56064
+ /** Errors associated with the action attempt. Null for pending action attempts. */
56065
+ error: null
56066
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
56067
+ }
56068
+ | {
56069
+ /** ID of the action attempt. */
56070
+ action_attempt_id: string
56071
+ status: 'success'
56072
+ /** Errors associated with the action attempt. Null for successful action attempts. */
56073
+ error: null
56074
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
56075
+ result: {}
56076
+ }
56077
+ | {
56078
+ /** ID of the action attempt. */
56079
+ action_attempt_id: string
56080
+ status: 'error'
56081
+ /** Result of the action attempt. Null for failed action attempts. */
56082
+ result: null
56083
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
56084
+ error: {
56085
+ type: string
56086
+ message: string
56087
+ }
56088
+ }
52353
56089
  | {
52354
56090
  /** ID of the action attempt. */
52355
56091
  action_attempt_id: string
@@ -52577,6 +56313,27 @@ export interface Routes {
52577
56313
  }
52578
56314
  }
52579
56315
  }
56316
+ '/workspaces/update': {
56317
+ route: '/workspaces/update'
56318
+ method: 'POST' | 'PATCH'
56319
+ queryParams: {}
56320
+ jsonBody: {
56321
+ name?: string | undefined
56322
+ connect_partner_name?: string | undefined
56323
+ connect_webview_customization?:
56324
+ | {
56325
+ primary_button_color?: (string | null) | undefined
56326
+ primary_button_text_color?: (string | null) | undefined
56327
+ success_message?: (string | null) | undefined
56328
+ logo_shape?: (('circle' | 'square') | null) | undefined
56329
+ }
56330
+ | undefined
56331
+ is_suspended?: boolean | undefined
56332
+ }
56333
+ commonParams: {}
56334
+ formData: {}
56335
+ jsonResponse: {}
56336
+ }
52580
56337
  }
52581
56338
 
52582
56339
  export type RouteResponse<Path extends keyof Routes> =