@seamapi/types 1.252.0 → 1.252.2

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.
@@ -3280,93 +3280,355 @@ export interface Routes {
3280
3280
  }>
3281
3281
  }
3282
3282
  }
3283
- '/acs/credentials/read_card': {
3284
- route: '/acs/credentials/read_card'
3285
- method: 'POST'
3283
+ '/acs/credentials/unassign': {
3284
+ route: '/acs/credentials/unassign'
3285
+ method: 'PATCH' | 'POST'
3286
+ queryParams: {}
3287
+ jsonBody: {
3288
+ acs_user_id: string
3289
+ acs_credential_id: string
3290
+ }
3291
+ commonParams: {}
3292
+ formData: {}
3293
+ jsonResponse: {
3294
+ acs_credential: {
3295
+ acs_credential_id: string
3296
+ acs_user_id?: string | undefined
3297
+ acs_credential_pool_id?: string | undefined
3298
+ acs_system_id: string
3299
+ parent_acs_credential_id?: string | undefined
3300
+ display_name: string
3301
+ code?: (string | undefined) | null
3302
+ card_number?: (string | undefined) | null
3303
+ is_encoded?: boolean | undefined
3304
+ encoded_at?: (string | undefined) | null
3305
+ access_method: 'code' | 'card' | 'mobile_key'
3306
+ external_type?:
3307
+ | (
3308
+ | 'pti_card'
3309
+ | 'brivo_credential'
3310
+ | 'hid_credential'
3311
+ | 'visionline_card'
3312
+ | 'salto_ks_credential'
3313
+ )
3314
+ | undefined
3315
+ external_type_display_name?: string | undefined
3316
+ created_at: string
3317
+ workspace_id: string
3318
+ starts_at?: string | undefined
3319
+ ends_at?: string | undefined
3320
+ errors: Array<{
3321
+ error_code: string
3322
+ message: string
3323
+ }>
3324
+ warnings: Array<{
3325
+ warning_code: string
3326
+ message: string
3327
+ }>
3328
+ is_multi_phone_sync_credential?: boolean | undefined
3329
+ is_latest_desired_state_synced_with_provider?: boolean | undefined
3330
+ latest_desired_state_synced_with_provider_at?: string | undefined
3331
+ visionline_metadata?:
3332
+ | {
3333
+ card_function_type: 'guest' | 'staff'
3334
+ joiner_acs_credential_ids?: string[] | undefined
3335
+ guest_acs_entrance_ids?: string[] | undefined
3336
+ common_acs_entrance_ids?: string[] | undefined
3337
+ is_valid?: boolean | undefined
3338
+ card_id?: string | undefined
3339
+ credential_id?: string | undefined
3340
+ }
3341
+ | undefined
3342
+ is_managed: true
3343
+ }
3344
+ }
3345
+ }
3346
+ '/acs/credentials/unmanaged/get': {
3347
+ route: '/acs/credentials/unmanaged/get'
3348
+ method: 'GET' | 'POST'
3349
+ queryParams: {}
3350
+ jsonBody: {}
3351
+ commonParams: {
3352
+ acs_credential_id: string
3353
+ }
3354
+ formData: {}
3355
+ jsonResponse: {
3356
+ acs_credential: {
3357
+ acs_credential_id: string
3358
+ acs_user_id?: string | undefined
3359
+ acs_credential_pool_id?: string | undefined
3360
+ acs_system_id: string
3361
+ parent_acs_credential_id?: string | undefined
3362
+ display_name: string
3363
+ code?: (string | undefined) | null
3364
+ card_number?: (string | undefined) | null
3365
+ is_encoded?: boolean | undefined
3366
+ encoded_at?: (string | undefined) | null
3367
+ access_method: 'code' | 'card' | 'mobile_key'
3368
+ external_type?:
3369
+ | (
3370
+ | 'pti_card'
3371
+ | 'brivo_credential'
3372
+ | 'hid_credential'
3373
+ | 'visionline_card'
3374
+ | 'salto_ks_credential'
3375
+ )
3376
+ | undefined
3377
+ external_type_display_name?: string | undefined
3378
+ created_at: string
3379
+ workspace_id: string
3380
+ starts_at?: string | undefined
3381
+ ends_at?: string | undefined
3382
+ errors: Array<{
3383
+ error_code: string
3384
+ message: string
3385
+ }>
3386
+ warnings: Array<{
3387
+ warning_code: string
3388
+ message: string
3389
+ }>
3390
+ is_multi_phone_sync_credential?: boolean | undefined
3391
+ is_latest_desired_state_synced_with_provider?: boolean | undefined
3392
+ latest_desired_state_synced_with_provider_at?: string | undefined
3393
+ visionline_metadata?:
3394
+ | {
3395
+ card_function_type: 'guest' | 'staff'
3396
+ joiner_acs_credential_ids?: string[] | undefined
3397
+ guest_acs_entrance_ids?: string[] | undefined
3398
+ common_acs_entrance_ids?: string[] | undefined
3399
+ is_valid?: boolean | undefined
3400
+ card_id?: string | undefined
3401
+ credential_id?: string | undefined
3402
+ }
3403
+ | undefined
3404
+ is_managed: false
3405
+ }
3406
+ }
3407
+ }
3408
+ '/acs/credentials/unmanaged/list': {
3409
+ route: '/acs/credentials/unmanaged/list'
3410
+ method: 'GET' | 'POST'
3286
3411
  queryParams: {}
3287
3412
  jsonBody: {}
3288
3413
  commonParams:
3414
+ | {
3415
+ acs_user_id: string
3416
+ }
3289
3417
  | {
3290
3418
  acs_system_id: string
3291
- device_name: string
3292
3419
  }
3293
3420
  | {
3294
- device_id: string
3421
+ acs_user_id: string
3422
+ acs_system_id: string
3423
+ }
3424
+ | {
3425
+ user_identity_id: string
3295
3426
  }
3296
3427
  formData: {}
3297
3428
  jsonResponse: {
3298
- action_attempt:
3299
- | {
3300
- /** The ID of the action attempt. */
3301
- action_attempt_id: string
3302
- status: 'pending'
3303
- result: null
3304
- error: null
3305
- action_type: 'LOCK_DOOR'
3306
- }
3307
- | {
3308
- /** The ID of the action attempt. */
3309
- action_attempt_id: string
3310
- status: 'success'
3311
- error: null
3312
- action_type: 'LOCK_DOOR'
3313
- result: {}
3314
- }
3315
- | {
3316
- /** The ID of the action attempt. */
3317
- action_attempt_id: string
3318
- status: 'error'
3319
- result: null
3320
- action_type: 'LOCK_DOOR'
3321
- error: {
3322
- type: string
3323
- message: string
3324
- }
3325
- }
3326
- | {
3327
- /** The ID of the action attempt. */
3328
- action_attempt_id: string
3329
- status: 'pending'
3330
- result: null
3331
- error: null
3332
- action_type: 'UNLOCK_DOOR'
3333
- }
3334
- | {
3335
- /** The ID of the action attempt. */
3336
- action_attempt_id: string
3337
- status: 'success'
3338
- error: null
3339
- action_type: 'UNLOCK_DOOR'
3340
- result: {}
3341
- }
3342
- | {
3343
- /** The ID of the action attempt. */
3344
- action_attempt_id: string
3345
- status: 'error'
3346
- result: null
3347
- action_type: 'UNLOCK_DOOR'
3348
- error: {
3349
- type: string
3350
- message: string
3429
+ acs_credentials: Array<{
3430
+ acs_credential_id: string
3431
+ acs_user_id?: string | undefined
3432
+ acs_credential_pool_id?: string | undefined
3433
+ acs_system_id: string
3434
+ parent_acs_credential_id?: string | undefined
3435
+ display_name: string
3436
+ code?: (string | undefined) | null
3437
+ card_number?: (string | undefined) | null
3438
+ is_encoded?: boolean | undefined
3439
+ encoded_at?: (string | undefined) | null
3440
+ access_method: 'code' | 'card' | 'mobile_key'
3441
+ external_type?:
3442
+ | (
3443
+ | 'pti_card'
3444
+ | 'brivo_credential'
3445
+ | 'hid_credential'
3446
+ | 'visionline_card'
3447
+ | 'salto_ks_credential'
3448
+ )
3449
+ | undefined
3450
+ external_type_display_name?: string | undefined
3451
+ created_at: string
3452
+ workspace_id: string
3453
+ starts_at?: string | undefined
3454
+ ends_at?: string | undefined
3455
+ errors: Array<{
3456
+ error_code: string
3457
+ message: string
3458
+ }>
3459
+ warnings: Array<{
3460
+ warning_code: string
3461
+ message: string
3462
+ }>
3463
+ is_multi_phone_sync_credential?: boolean | undefined
3464
+ is_latest_desired_state_synced_with_provider?: boolean | undefined
3465
+ latest_desired_state_synced_with_provider_at?: string | undefined
3466
+ visionline_metadata?:
3467
+ | {
3468
+ card_function_type: 'guest' | 'staff'
3469
+ joiner_acs_credential_ids?: string[] | undefined
3470
+ guest_acs_entrance_ids?: string[] | undefined
3471
+ common_acs_entrance_ids?: string[] | undefined
3472
+ is_valid?: boolean | undefined
3473
+ card_id?: string | undefined
3474
+ credential_id?: string | undefined
3351
3475
  }
3352
- }
3353
- | {
3354
- /** The ID of the action attempt. */
3355
- action_attempt_id: string
3356
- status: 'pending'
3357
- result: null
3358
- error: null
3359
- action_type: 'READ_CARD'
3360
- }
3361
- | {
3362
- /** The ID of the action attempt. */
3363
- action_attempt_id: string
3364
- status: 'success'
3365
- error: null
3366
- action_type: 'READ_CARD'
3367
- result: {
3368
- /** Matching acs_credential currently encoded on this card. */
3369
- acs_credential_id: string | null
3476
+ | undefined
3477
+ is_managed: false
3478
+ }>
3479
+ }
3480
+ }
3481
+ '/acs/credentials/update': {
3482
+ route: '/acs/credentials/update'
3483
+ method: 'PATCH' | 'POST'
3484
+ queryParams: {}
3485
+ jsonBody: {
3486
+ acs_credential_id: string
3487
+ code?: string | undefined
3488
+ ends_at?: string | undefined
3489
+ }
3490
+ commonParams: {}
3491
+ formData: {}
3492
+ jsonResponse: {
3493
+ acs_credential: {
3494
+ acs_credential_id: string
3495
+ acs_user_id?: string | undefined
3496
+ acs_credential_pool_id?: string | undefined
3497
+ acs_system_id: string
3498
+ parent_acs_credential_id?: string | undefined
3499
+ display_name: string
3500
+ code?: (string | undefined) | null
3501
+ card_number?: (string | undefined) | null
3502
+ is_encoded?: boolean | undefined
3503
+ encoded_at?: (string | undefined) | null
3504
+ access_method: 'code' | 'card' | 'mobile_key'
3505
+ external_type?:
3506
+ | (
3507
+ | 'pti_card'
3508
+ | 'brivo_credential'
3509
+ | 'hid_credential'
3510
+ | 'visionline_card'
3511
+ | 'salto_ks_credential'
3512
+ )
3513
+ | undefined
3514
+ external_type_display_name?: string | undefined
3515
+ created_at: string
3516
+ workspace_id: string
3517
+ starts_at?: string | undefined
3518
+ ends_at?: string | undefined
3519
+ errors: Array<{
3520
+ error_code: string
3521
+ message: string
3522
+ }>
3523
+ warnings: Array<{
3524
+ warning_code: string
3525
+ message: string
3526
+ }>
3527
+ is_multi_phone_sync_credential?: boolean | undefined
3528
+ is_latest_desired_state_synced_with_provider?: boolean | undefined
3529
+ latest_desired_state_synced_with_provider_at?: string | undefined
3530
+ visionline_metadata?:
3531
+ | {
3532
+ card_function_type: 'guest' | 'staff'
3533
+ joiner_acs_credential_ids?: string[] | undefined
3534
+ guest_acs_entrance_ids?: string[] | undefined
3535
+ common_acs_entrance_ids?: string[] | undefined
3536
+ is_valid?: boolean | undefined
3537
+ card_id?: string | undefined
3538
+ credential_id?: string | undefined
3539
+ }
3540
+ | undefined
3541
+ is_managed: true
3542
+ }
3543
+ }
3544
+ }
3545
+ '/acs/encoders/read_card': {
3546
+ route: '/acs/encoders/read_card'
3547
+ method: 'POST'
3548
+ queryParams: {}
3549
+ jsonBody: {}
3550
+ commonParams:
3551
+ | {
3552
+ acs_system_id: string
3553
+ device_name: string
3554
+ }
3555
+ | {
3556
+ device_id: string
3557
+ }
3558
+ formData: {}
3559
+ jsonResponse: {
3560
+ action_attempt:
3561
+ | {
3562
+ /** The ID of the action attempt. */
3563
+ action_attempt_id: string
3564
+ status: 'pending'
3565
+ result: null
3566
+ error: null
3567
+ action_type: 'LOCK_DOOR'
3568
+ }
3569
+ | {
3570
+ /** The ID of the action attempt. */
3571
+ action_attempt_id: string
3572
+ status: 'success'
3573
+ error: null
3574
+ action_type: 'LOCK_DOOR'
3575
+ result: {}
3576
+ }
3577
+ | {
3578
+ /** The ID of the action attempt. */
3579
+ action_attempt_id: string
3580
+ status: 'error'
3581
+ result: null
3582
+ action_type: 'LOCK_DOOR'
3583
+ error: {
3584
+ type: string
3585
+ message: string
3586
+ }
3587
+ }
3588
+ | {
3589
+ /** The ID of the action attempt. */
3590
+ action_attempt_id: string
3591
+ status: 'pending'
3592
+ result: null
3593
+ error: null
3594
+ action_type: 'UNLOCK_DOOR'
3595
+ }
3596
+ | {
3597
+ /** The ID of the action attempt. */
3598
+ action_attempt_id: string
3599
+ status: 'success'
3600
+ error: null
3601
+ action_type: 'UNLOCK_DOOR'
3602
+ result: {}
3603
+ }
3604
+ | {
3605
+ /** The ID of the action attempt. */
3606
+ action_attempt_id: string
3607
+ status: 'error'
3608
+ result: null
3609
+ action_type: 'UNLOCK_DOOR'
3610
+ error: {
3611
+ type: string
3612
+ message: string
3613
+ }
3614
+ }
3615
+ | {
3616
+ /** The ID of the action attempt. */
3617
+ action_attempt_id: string
3618
+ status: 'pending'
3619
+ result: null
3620
+ error: null
3621
+ action_type: 'READ_CARD'
3622
+ }
3623
+ | {
3624
+ /** The ID of the action attempt. */
3625
+ action_attempt_id: string
3626
+ status: 'success'
3627
+ error: null
3628
+ action_type: 'READ_CARD'
3629
+ result: {
3630
+ /** Matching acs_credential currently encoded on this card. */
3631
+ acs_credential_id: string | null
3370
3632
  /** A number or sting that physically identifies this card. */
3371
3633
  card_number: string | null
3372
3634
  }
@@ -3762,268 +4024,6 @@ export interface Routes {
3762
4024
  }
3763
4025
  }
3764
4026
  }
3765
- '/acs/credentials/unassign': {
3766
- route: '/acs/credentials/unassign'
3767
- method: 'PATCH' | 'POST'
3768
- queryParams: {}
3769
- jsonBody: {
3770
- acs_user_id: string
3771
- acs_credential_id: string
3772
- }
3773
- commonParams: {}
3774
- formData: {}
3775
- jsonResponse: {
3776
- acs_credential: {
3777
- acs_credential_id: string
3778
- acs_user_id?: string | undefined
3779
- acs_credential_pool_id?: string | undefined
3780
- acs_system_id: string
3781
- parent_acs_credential_id?: string | undefined
3782
- display_name: string
3783
- code?: (string | undefined) | null
3784
- card_number?: (string | undefined) | null
3785
- is_encoded?: boolean | undefined
3786
- encoded_at?: (string | undefined) | null
3787
- access_method: 'code' | 'card' | 'mobile_key'
3788
- external_type?:
3789
- | (
3790
- | 'pti_card'
3791
- | 'brivo_credential'
3792
- | 'hid_credential'
3793
- | 'visionline_card'
3794
- | 'salto_ks_credential'
3795
- )
3796
- | undefined
3797
- external_type_display_name?: string | undefined
3798
- created_at: string
3799
- workspace_id: string
3800
- starts_at?: string | undefined
3801
- ends_at?: string | undefined
3802
- errors: Array<{
3803
- error_code: string
3804
- message: string
3805
- }>
3806
- warnings: Array<{
3807
- warning_code: string
3808
- message: string
3809
- }>
3810
- is_multi_phone_sync_credential?: boolean | undefined
3811
- is_latest_desired_state_synced_with_provider?: boolean | undefined
3812
- latest_desired_state_synced_with_provider_at?: string | undefined
3813
- visionline_metadata?:
3814
- | {
3815
- card_function_type: 'guest' | 'staff'
3816
- joiner_acs_credential_ids?: string[] | undefined
3817
- guest_acs_entrance_ids?: string[] | undefined
3818
- common_acs_entrance_ids?: string[] | undefined
3819
- is_valid?: boolean | undefined
3820
- card_id?: string | undefined
3821
- credential_id?: string | undefined
3822
- }
3823
- | undefined
3824
- is_managed: true
3825
- }
3826
- }
3827
- }
3828
- '/acs/credentials/unmanaged/get': {
3829
- route: '/acs/credentials/unmanaged/get'
3830
- method: 'GET' | 'POST'
3831
- queryParams: {}
3832
- jsonBody: {}
3833
- commonParams: {
3834
- acs_credential_id: string
3835
- }
3836
- formData: {}
3837
- jsonResponse: {
3838
- acs_credential: {
3839
- acs_credential_id: string
3840
- acs_user_id?: string | undefined
3841
- acs_credential_pool_id?: string | undefined
3842
- acs_system_id: string
3843
- parent_acs_credential_id?: string | undefined
3844
- display_name: string
3845
- code?: (string | undefined) | null
3846
- card_number?: (string | undefined) | null
3847
- is_encoded?: boolean | undefined
3848
- encoded_at?: (string | undefined) | null
3849
- access_method: 'code' | 'card' | 'mobile_key'
3850
- external_type?:
3851
- | (
3852
- | 'pti_card'
3853
- | 'brivo_credential'
3854
- | 'hid_credential'
3855
- | 'visionline_card'
3856
- | 'salto_ks_credential'
3857
- )
3858
- | undefined
3859
- external_type_display_name?: string | undefined
3860
- created_at: string
3861
- workspace_id: string
3862
- starts_at?: string | undefined
3863
- ends_at?: string | undefined
3864
- errors: Array<{
3865
- error_code: string
3866
- message: string
3867
- }>
3868
- warnings: Array<{
3869
- warning_code: string
3870
- message: string
3871
- }>
3872
- is_multi_phone_sync_credential?: boolean | undefined
3873
- is_latest_desired_state_synced_with_provider?: boolean | undefined
3874
- latest_desired_state_synced_with_provider_at?: string | undefined
3875
- visionline_metadata?:
3876
- | {
3877
- card_function_type: 'guest' | 'staff'
3878
- joiner_acs_credential_ids?: string[] | undefined
3879
- guest_acs_entrance_ids?: string[] | undefined
3880
- common_acs_entrance_ids?: string[] | undefined
3881
- is_valid?: boolean | undefined
3882
- card_id?: string | undefined
3883
- credential_id?: string | undefined
3884
- }
3885
- | undefined
3886
- is_managed: false
3887
- }
3888
- }
3889
- }
3890
- '/acs/credentials/unmanaged/list': {
3891
- route: '/acs/credentials/unmanaged/list'
3892
- method: 'GET' | 'POST'
3893
- queryParams: {}
3894
- jsonBody: {}
3895
- commonParams:
3896
- | {
3897
- acs_user_id: string
3898
- }
3899
- | {
3900
- acs_system_id: string
3901
- }
3902
- | {
3903
- acs_user_id: string
3904
- acs_system_id: string
3905
- }
3906
- | {
3907
- user_identity_id: string
3908
- }
3909
- formData: {}
3910
- jsonResponse: {
3911
- acs_credentials: Array<{
3912
- acs_credential_id: string
3913
- acs_user_id?: string | undefined
3914
- acs_credential_pool_id?: string | undefined
3915
- acs_system_id: string
3916
- parent_acs_credential_id?: string | undefined
3917
- display_name: string
3918
- code?: (string | undefined) | null
3919
- card_number?: (string | undefined) | null
3920
- is_encoded?: boolean | undefined
3921
- encoded_at?: (string | undefined) | null
3922
- access_method: 'code' | 'card' | 'mobile_key'
3923
- external_type?:
3924
- | (
3925
- | 'pti_card'
3926
- | 'brivo_credential'
3927
- | 'hid_credential'
3928
- | 'visionline_card'
3929
- | 'salto_ks_credential'
3930
- )
3931
- | undefined
3932
- external_type_display_name?: string | undefined
3933
- created_at: string
3934
- workspace_id: string
3935
- starts_at?: string | undefined
3936
- ends_at?: string | undefined
3937
- errors: Array<{
3938
- error_code: string
3939
- message: string
3940
- }>
3941
- warnings: Array<{
3942
- warning_code: string
3943
- message: string
3944
- }>
3945
- is_multi_phone_sync_credential?: boolean | undefined
3946
- is_latest_desired_state_synced_with_provider?: boolean | undefined
3947
- latest_desired_state_synced_with_provider_at?: string | undefined
3948
- visionline_metadata?:
3949
- | {
3950
- card_function_type: 'guest' | 'staff'
3951
- joiner_acs_credential_ids?: string[] | undefined
3952
- guest_acs_entrance_ids?: string[] | undefined
3953
- common_acs_entrance_ids?: string[] | undefined
3954
- is_valid?: boolean | undefined
3955
- card_id?: string | undefined
3956
- credential_id?: string | undefined
3957
- }
3958
- | undefined
3959
- is_managed: false
3960
- }>
3961
- }
3962
- }
3963
- '/acs/credentials/update': {
3964
- route: '/acs/credentials/update'
3965
- method: 'PATCH' | 'POST'
3966
- queryParams: {}
3967
- jsonBody: {
3968
- acs_credential_id: string
3969
- code?: string | undefined
3970
- ends_at?: string | undefined
3971
- }
3972
- commonParams: {}
3973
- formData: {}
3974
- jsonResponse: {
3975
- acs_credential: {
3976
- acs_credential_id: string
3977
- acs_user_id?: string | undefined
3978
- acs_credential_pool_id?: string | undefined
3979
- acs_system_id: string
3980
- parent_acs_credential_id?: string | undefined
3981
- display_name: string
3982
- code?: (string | undefined) | null
3983
- card_number?: (string | undefined) | null
3984
- is_encoded?: boolean | undefined
3985
- encoded_at?: (string | undefined) | null
3986
- access_method: 'code' | 'card' | 'mobile_key'
3987
- external_type?:
3988
- | (
3989
- | 'pti_card'
3990
- | 'brivo_credential'
3991
- | 'hid_credential'
3992
- | 'visionline_card'
3993
- | 'salto_ks_credential'
3994
- )
3995
- | undefined
3996
- external_type_display_name?: string | undefined
3997
- created_at: string
3998
- workspace_id: string
3999
- starts_at?: string | undefined
4000
- ends_at?: string | undefined
4001
- errors: Array<{
4002
- error_code: string
4003
- message: string
4004
- }>
4005
- warnings: Array<{
4006
- warning_code: string
4007
- message: string
4008
- }>
4009
- is_multi_phone_sync_credential?: boolean | undefined
4010
- is_latest_desired_state_synced_with_provider?: boolean | undefined
4011
- latest_desired_state_synced_with_provider_at?: string | undefined
4012
- visionline_metadata?:
4013
- | {
4014
- card_function_type: 'guest' | 'staff'
4015
- joiner_acs_credential_ids?: string[] | undefined
4016
- guest_acs_entrance_ids?: string[] | undefined
4017
- common_acs_entrance_ids?: string[] | undefined
4018
- is_valid?: boolean | undefined
4019
- card_id?: string | undefined
4020
- credential_id?: string | undefined
4021
- }
4022
- | undefined
4023
- is_managed: true
4024
- }
4025
- }
4026
- }
4027
4027
  '/acs/entrances/get': {
4028
4028
  route: '/acs/entrances/get'
4029
4029
  method: 'GET' | 'POST'