@seamapi/types 1.245.1 → 1.247.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.
@@ -2318,25 +2318,41 @@ export interface Routes {
2318
2318
  formData: {};
2319
2319
  jsonResponse: {
2320
2320
  acs_users: Array<{
2321
+ /** ID of the `acs_user`. */
2321
2322
  acs_user_id: string;
2323
+ /** ID of the access control system that contains the `acs_user`. */
2322
2324
  acs_system_id: string;
2323
2325
  hid_acs_system_id?: string | undefined;
2326
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
2324
2327
  workspace_id: string;
2328
+ /** Date and time at which the `acs_user` was created. */
2325
2329
  created_at: string;
2330
+ /** Display name for the `acs_user`. */
2326
2331
  display_name: string;
2332
+ /** Brand-specific terminology for the `acs_user` type. */
2327
2333
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
2334
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
2328
2335
  external_type_display_name?: string | undefined;
2336
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
2329
2337
  is_suspended: boolean;
2338
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
2330
2339
  access_schedule?: {
2331
2340
  starts_at: string;
2332
2341
  ends_at: string;
2333
2342
  } | undefined;
2343
+ /** ID of the user identity associated with the `acs_user`. */
2334
2344
  user_identity_id?: string | undefined;
2345
+ /** Full name of the user identity associated with the `acs_user`. */
2335
2346
  user_identity_full_name?: (string | null) | undefined;
2347
+ /** Email address of the user identity associated with the `acs_user`. */
2336
2348
  user_identity_email_address?: (string | null) | undefined;
2349
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
2337
2350
  user_identity_phone_number?: (string | null) | undefined;
2351
+ /** */
2338
2352
  latest_desired_state_synced_with_provider_at?: string | undefined;
2353
+ /** */
2339
2354
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
2355
+ /** Warnings associated with the `acs_user`. */
2340
2356
  warnings: Array<{
2341
2357
  created_at: string;
2342
2358
  message: string;
@@ -2346,6 +2362,7 @@ export interface Routes {
2346
2362
  message: string;
2347
2363
  warning_code: 'salto_ks_user_not_subscribed';
2348
2364
  }>;
2365
+ /** Errors associated with the `acs_user`. */
2349
2366
  errors: Array<{
2350
2367
  /** Date and time at which Seam created the error. */
2351
2368
  created_at: string;
@@ -2377,11 +2394,14 @@ export interface Routes {
2377
2394
  message: string;
2378
2395
  error_code: 'failed_to_delete_on_acs_system';
2379
2396
  }>;
2397
+ /** Full name of the `acs_user`. */
2380
2398
  full_name?: string | undefined;
2381
2399
  /**
2382
2400
  * @deprecated use email_address. */
2383
2401
  email?: string | undefined;
2402
+ /** Email address of the `acs_user`. */
2384
2403
  email_address?: string | undefined;
2404
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
2385
2405
  phone_number?: string | undefined;
2386
2406
  is_managed: true;
2387
2407
  }>;
@@ -3425,7 +3445,9 @@ export interface Routes {
3425
3445
  queryParams: {};
3426
3446
  jsonBody: {};
3427
3447
  commonParams: {
3448
+ /** ID of the desired `acs_user`. */
3428
3449
  acs_user_id: string;
3450
+ /** ID of the desired access group. */
3429
3451
  acs_access_group_id: string;
3430
3452
  };
3431
3453
  formData: {};
@@ -3436,43 +3458,66 @@ export interface Routes {
3436
3458
  method: 'POST';
3437
3459
  queryParams: {};
3438
3460
  jsonBody: {
3461
+ /** ID of the `acs_system` to which to add the new `acs_user`. */
3439
3462
  acs_system_id: string;
3463
+ /** Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. */
3440
3464
  acs_access_group_ids?: string[];
3465
+ /** ID of the user identity with which to associate the new `acs_user`. */
3441
3466
  user_identity_id?: string | undefined;
3467
+ /** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
3442
3468
  access_schedule?: {
3443
3469
  starts_at: string;
3444
3470
  ends_at: string;
3445
3471
  } | undefined;
3472
+ /** Full name of the `acs_user`. */
3446
3473
  full_name?: string | undefined;
3447
3474
  /**
3448
3475
  * @deprecated use email_address. */
3449
3476
  email?: string | undefined;
3477
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
3450
3478
  phone_number?: string | undefined;
3479
+ /** Email address of the `acs_user`. */
3451
3480
  email_address?: string | undefined;
3452
3481
  };
3453
3482
  commonParams: {};
3454
3483
  formData: {};
3455
3484
  jsonResponse: {
3456
3485
  acs_user: {
3486
+ /** ID of the `acs_user`. */
3457
3487
  acs_user_id: string;
3488
+ /** ID of the access control system that contains the `acs_user`. */
3458
3489
  acs_system_id: string;
3459
3490
  hid_acs_system_id?: string | undefined;
3491
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
3460
3492
  workspace_id: string;
3493
+ /** Date and time at which the `acs_user` was created. */
3461
3494
  created_at: string;
3495
+ /** Display name for the `acs_user`. */
3462
3496
  display_name: string;
3497
+ /** Brand-specific terminology for the `acs_user` type. */
3463
3498
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
3499
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
3464
3500
  external_type_display_name?: string | undefined;
3501
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
3465
3502
  is_suspended: boolean;
3503
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
3466
3504
  access_schedule?: {
3467
3505
  starts_at: string;
3468
3506
  ends_at: string;
3469
3507
  } | undefined;
3508
+ /** ID of the user identity associated with the `acs_user`. */
3470
3509
  user_identity_id?: string | undefined;
3510
+ /** Full name of the user identity associated with the `acs_user`. */
3471
3511
  user_identity_full_name?: (string | null) | undefined;
3512
+ /** Email address of the user identity associated with the `acs_user`. */
3472
3513
  user_identity_email_address?: (string | null) | undefined;
3514
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
3473
3515
  user_identity_phone_number?: (string | null) | undefined;
3516
+ /** */
3474
3517
  latest_desired_state_synced_with_provider_at?: string | undefined;
3518
+ /** */
3475
3519
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
3520
+ /** Warnings associated with the `acs_user`. */
3476
3521
  warnings: Array<{
3477
3522
  created_at: string;
3478
3523
  message: string;
@@ -3482,6 +3527,7 @@ export interface Routes {
3482
3527
  message: string;
3483
3528
  warning_code: 'salto_ks_user_not_subscribed';
3484
3529
  }>;
3530
+ /** Errors associated with the `acs_user`. */
3485
3531
  errors: Array<{
3486
3532
  /** Date and time at which Seam created the error. */
3487
3533
  created_at: string;
@@ -3513,11 +3559,14 @@ export interface Routes {
3513
3559
  message: string;
3514
3560
  error_code: 'failed_to_delete_on_acs_system';
3515
3561
  }>;
3562
+ /** Full name of the `acs_user`. */
3516
3563
  full_name?: string | undefined;
3517
3564
  /**
3518
3565
  * @deprecated use email_address. */
3519
3566
  email?: string | undefined;
3567
+ /** Email address of the `acs_user`. */
3520
3568
  email_address?: string | undefined;
3569
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
3521
3570
  phone_number?: string | undefined;
3522
3571
  is_managed: true;
3523
3572
  };
@@ -3529,6 +3578,7 @@ export interface Routes {
3529
3578
  queryParams: {};
3530
3579
  jsonBody: {};
3531
3580
  commonParams: {
3581
+ /** ID of the desired `acs_user`. */
3532
3582
  acs_user_id: string;
3533
3583
  };
3534
3584
  formData: {};
@@ -3540,30 +3590,47 @@ export interface Routes {
3540
3590
  queryParams: {};
3541
3591
  jsonBody: {};
3542
3592
  commonParams: {
3593
+ /** ID of the desired `acs_user`. */
3543
3594
  acs_user_id: string;
3544
3595
  };
3545
3596
  formData: {};
3546
3597
  jsonResponse: {
3547
3598
  acs_user: {
3599
+ /** ID of the `acs_user`. */
3548
3600
  acs_user_id: string;
3601
+ /** ID of the access control system that contains the `acs_user`. */
3549
3602
  acs_system_id: string;
3550
3603
  hid_acs_system_id?: string | undefined;
3604
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
3551
3605
  workspace_id: string;
3606
+ /** Date and time at which the `acs_user` was created. */
3552
3607
  created_at: string;
3608
+ /** Display name for the `acs_user`. */
3553
3609
  display_name: string;
3610
+ /** Brand-specific terminology for the `acs_user` type. */
3554
3611
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
3612
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
3555
3613
  external_type_display_name?: string | undefined;
3614
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
3556
3615
  is_suspended: boolean;
3616
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
3557
3617
  access_schedule?: {
3558
3618
  starts_at: string;
3559
3619
  ends_at: string;
3560
3620
  } | undefined;
3621
+ /** ID of the user identity associated with the `acs_user`. */
3561
3622
  user_identity_id?: string | undefined;
3623
+ /** Full name of the user identity associated with the `acs_user`. */
3562
3624
  user_identity_full_name?: (string | null) | undefined;
3625
+ /** Email address of the user identity associated with the `acs_user`. */
3563
3626
  user_identity_email_address?: (string | null) | undefined;
3627
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
3564
3628
  user_identity_phone_number?: (string | null) | undefined;
3629
+ /** */
3565
3630
  latest_desired_state_synced_with_provider_at?: string | undefined;
3631
+ /** */
3566
3632
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
3633
+ /** Warnings associated with the `acs_user`. */
3567
3634
  warnings: Array<{
3568
3635
  created_at: string;
3569
3636
  message: string;
@@ -3573,6 +3640,7 @@ export interface Routes {
3573
3640
  message: string;
3574
3641
  warning_code: 'salto_ks_user_not_subscribed';
3575
3642
  }>;
3643
+ /** Errors associated with the `acs_user`. */
3576
3644
  errors: Array<{
3577
3645
  /** Date and time at which Seam created the error. */
3578
3646
  created_at: string;
@@ -3604,11 +3672,14 @@ export interface Routes {
3604
3672
  message: string;
3605
3673
  error_code: 'failed_to_delete_on_acs_system';
3606
3674
  }>;
3675
+ /** Full name of the `acs_user`. */
3607
3676
  full_name?: string | undefined;
3608
3677
  /**
3609
3678
  * @deprecated use email_address. */
3610
3679
  email?: string | undefined;
3680
+ /** Email address of the `acs_user`. */
3611
3681
  email_address?: string | undefined;
3682
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
3612
3683
  phone_number?: string | undefined;
3613
3684
  is_managed: true;
3614
3685
  };
@@ -3620,9 +3691,13 @@ export interface Routes {
3620
3691
  queryParams: {};
3621
3692
  jsonBody: {};
3622
3693
  commonParams: {
3694
+ /** ID of the user identity for which you want to retrieve all `acs_user`s. */
3623
3695
  user_identity_id?: string | undefined;
3696
+ /** Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
3624
3697
  user_identity_phone_number?: string | undefined;
3698
+ /** Email address of the user identity for which you want to retrieve all `acs_user`s. */
3625
3699
  user_identity_email_address?: string | undefined;
3700
+ /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
3626
3701
  acs_system_id?: string | undefined;
3627
3702
  limit?: number;
3628
3703
  created_before?: Date | undefined;
@@ -3630,25 +3705,41 @@ export interface Routes {
3630
3705
  formData: {};
3631
3706
  jsonResponse: {
3632
3707
  acs_users: Array<{
3708
+ /** ID of the `acs_user`. */
3633
3709
  acs_user_id: string;
3710
+ /** ID of the access control system that contains the `acs_user`. */
3634
3711
  acs_system_id: string;
3635
3712
  hid_acs_system_id?: string | undefined;
3713
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
3636
3714
  workspace_id: string;
3715
+ /** Date and time at which the `acs_user` was created. */
3637
3716
  created_at: string;
3717
+ /** Display name for the `acs_user`. */
3638
3718
  display_name: string;
3719
+ /** Brand-specific terminology for the `acs_user` type. */
3639
3720
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
3721
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
3640
3722
  external_type_display_name?: string | undefined;
3723
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
3641
3724
  is_suspended: boolean;
3725
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
3642
3726
  access_schedule?: {
3643
3727
  starts_at: string;
3644
3728
  ends_at: string;
3645
3729
  } | undefined;
3730
+ /** ID of the user identity associated with the `acs_user`. */
3646
3731
  user_identity_id?: string | undefined;
3732
+ /** Full name of the user identity associated with the `acs_user`. */
3647
3733
  user_identity_full_name?: (string | null) | undefined;
3734
+ /** Email address of the user identity associated with the `acs_user`. */
3648
3735
  user_identity_email_address?: (string | null) | undefined;
3736
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
3649
3737
  user_identity_phone_number?: (string | null) | undefined;
3738
+ /** */
3650
3739
  latest_desired_state_synced_with_provider_at?: string | undefined;
3740
+ /** */
3651
3741
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
3742
+ /** Warnings associated with the `acs_user`. */
3652
3743
  warnings: Array<{
3653
3744
  created_at: string;
3654
3745
  message: string;
@@ -3658,6 +3749,7 @@ export interface Routes {
3658
3749
  message: string;
3659
3750
  warning_code: 'salto_ks_user_not_subscribed';
3660
3751
  }>;
3752
+ /** Errors associated with the `acs_user`. */
3661
3753
  errors: Array<{
3662
3754
  /** Date and time at which Seam created the error. */
3663
3755
  created_at: string;
@@ -3689,11 +3781,14 @@ export interface Routes {
3689
3781
  message: string;
3690
3782
  error_code: 'failed_to_delete_on_acs_system';
3691
3783
  }>;
3784
+ /** Full name of the `acs_user`. */
3692
3785
  full_name?: string | undefined;
3693
3786
  /**
3694
3787
  * @deprecated use email_address. */
3695
3788
  email?: string | undefined;
3789
+ /** Email address of the `acs_user`. */
3696
3790
  email_address?: string | undefined;
3791
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
3697
3792
  phone_number?: string | undefined;
3698
3793
  is_managed: true;
3699
3794
  }>;
@@ -3705,6 +3800,7 @@ export interface Routes {
3705
3800
  queryParams: {};
3706
3801
  jsonBody: {};
3707
3802
  commonParams: {
3803
+ /** ID of the desired `acs_user`. */
3708
3804
  acs_user_id: string;
3709
3805
  };
3710
3806
  formData: {};
@@ -3741,7 +3837,9 @@ export interface Routes {
3741
3837
  queryParams: {};
3742
3838
  jsonBody: {};
3743
3839
  commonParams: {
3840
+ /** ID of the desired `acs_user`. */
3744
3841
  acs_user_id: string;
3842
+ /** ID of the desired access group. */
3745
3843
  acs_access_group_id: string;
3746
3844
  };
3747
3845
  formData: {};
@@ -3752,6 +3850,7 @@ export interface Routes {
3752
3850
  method: 'POST';
3753
3851
  queryParams: {};
3754
3852
  jsonBody: {
3853
+ /** ID of the desired `acs_user`. */
3755
3854
  acs_user_id: string;
3756
3855
  };
3757
3856
  commonParams: {};
@@ -3764,6 +3863,7 @@ export interface Routes {
3764
3863
  queryParams: {};
3765
3864
  jsonBody: {};
3766
3865
  commonParams: {
3866
+ /** ID of the desired `acs_user`. */
3767
3867
  acs_user_id: string;
3768
3868
  };
3769
3869
  formData: {};
@@ -3780,25 +3880,41 @@ export interface Routes {
3780
3880
  formData: {};
3781
3881
  jsonResponse: {
3782
3882
  acs_user: {
3883
+ /** ID of the `acs_user`. */
3783
3884
  acs_user_id: string;
3885
+ /** ID of the access control system that contains the `acs_user`. */
3784
3886
  acs_system_id: string;
3785
3887
  hid_acs_system_id?: string | undefined;
3888
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
3786
3889
  workspace_id: string;
3890
+ /** Date and time at which the `acs_user` was created. */
3787
3891
  created_at: string;
3892
+ /** Display name for the `acs_user`. */
3788
3893
  display_name: string;
3894
+ /** Brand-specific terminology for the `acs_user` type. */
3789
3895
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
3896
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
3790
3897
  external_type_display_name?: string | undefined;
3898
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
3791
3899
  is_suspended: boolean;
3900
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
3792
3901
  access_schedule?: {
3793
3902
  starts_at: string;
3794
3903
  ends_at: string;
3795
3904
  } | undefined;
3905
+ /** ID of the user identity associated with the `acs_user`. */
3796
3906
  user_identity_id?: string | undefined;
3907
+ /** Full name of the user identity associated with the `acs_user`. */
3797
3908
  user_identity_full_name?: (string | null) | undefined;
3909
+ /** Email address of the user identity associated with the `acs_user`. */
3798
3910
  user_identity_email_address?: (string | null) | undefined;
3911
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
3799
3912
  user_identity_phone_number?: (string | null) | undefined;
3913
+ /** */
3800
3914
  latest_desired_state_synced_with_provider_at?: string | undefined;
3915
+ /** */
3801
3916
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
3917
+ /** Warnings associated with the `acs_user`. */
3802
3918
  warnings: Array<{
3803
3919
  created_at: string;
3804
3920
  message: string;
@@ -3808,6 +3924,7 @@ export interface Routes {
3808
3924
  message: string;
3809
3925
  warning_code: 'salto_ks_user_not_subscribed';
3810
3926
  }>;
3927
+ /** Errors associated with the `acs_user`. */
3811
3928
  errors: Array<{
3812
3929
  /** Date and time at which Seam created the error. */
3813
3930
  created_at: string;
@@ -3839,11 +3956,14 @@ export interface Routes {
3839
3956
  message: string;
3840
3957
  error_code: 'failed_to_delete_on_acs_system';
3841
3958
  }>;
3959
+ /** Full name of the `acs_user`. */
3842
3960
  full_name?: string | undefined;
3843
3961
  /**
3844
3962
  * @deprecated use email_address. */
3845
3963
  email?: string | undefined;
3964
+ /** Email address of the `acs_user`. */
3846
3965
  email_address?: string | undefined;
3966
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
3847
3967
  phone_number?: string | undefined;
3848
3968
  is_managed: false;
3849
3969
  };
@@ -3864,25 +3984,41 @@ export interface Routes {
3864
3984
  formData: {};
3865
3985
  jsonResponse: {
3866
3986
  acs_users: Array<{
3987
+ /** ID of the `acs_user`. */
3867
3988
  acs_user_id: string;
3989
+ /** ID of the access control system that contains the `acs_user`. */
3868
3990
  acs_system_id: string;
3869
3991
  hid_acs_system_id?: string | undefined;
3992
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
3870
3993
  workspace_id: string;
3994
+ /** Date and time at which the `acs_user` was created. */
3871
3995
  created_at: string;
3996
+ /** Display name for the `acs_user`. */
3872
3997
  display_name: string;
3998
+ /** Brand-specific terminology for the `acs_user` type. */
3873
3999
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
4000
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
3874
4001
  external_type_display_name?: string | undefined;
4002
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
3875
4003
  is_suspended: boolean;
4004
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
3876
4005
  access_schedule?: {
3877
4006
  starts_at: string;
3878
4007
  ends_at: string;
3879
4008
  } | undefined;
4009
+ /** ID of the user identity associated with the `acs_user`. */
3880
4010
  user_identity_id?: string | undefined;
4011
+ /** Full name of the user identity associated with the `acs_user`. */
3881
4012
  user_identity_full_name?: (string | null) | undefined;
4013
+ /** Email address of the user identity associated with the `acs_user`. */
3882
4014
  user_identity_email_address?: (string | null) | undefined;
4015
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
3883
4016
  user_identity_phone_number?: (string | null) | undefined;
4017
+ /** */
3884
4018
  latest_desired_state_synced_with_provider_at?: string | undefined;
4019
+ /** */
3885
4020
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
4021
+ /** Warnings associated with the `acs_user`. */
3886
4022
  warnings: Array<{
3887
4023
  created_at: string;
3888
4024
  message: string;
@@ -3892,6 +4028,7 @@ export interface Routes {
3892
4028
  message: string;
3893
4029
  warning_code: 'salto_ks_user_not_subscribed';
3894
4030
  }>;
4031
+ /** Errors associated with the `acs_user`. */
3895
4032
  errors: Array<{
3896
4033
  /** Date and time at which Seam created the error. */
3897
4034
  created_at: string;
@@ -3923,11 +4060,14 @@ export interface Routes {
3923
4060
  message: string;
3924
4061
  error_code: 'failed_to_delete_on_acs_system';
3925
4062
  }>;
4063
+ /** Full name of the `acs_user`. */
3926
4064
  full_name?: string | undefined;
3927
4065
  /**
3928
4066
  * @deprecated use email_address. */
3929
4067
  email?: string | undefined;
4068
+ /** Email address of the `acs_user`. */
3930
4069
  email_address?: string | undefined;
4070
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
3931
4071
  phone_number?: string | undefined;
3932
4072
  is_managed: false;
3933
4073
  }>;
@@ -3939,6 +4079,7 @@ export interface Routes {
3939
4079
  queryParams: {};
3940
4080
  jsonBody: {};
3941
4081
  commonParams: {
4082
+ /** ID of the desired `acs_user`. */
3942
4083
  acs_user_id: string;
3943
4084
  };
3944
4085
  formData: {};
@@ -3949,16 +4090,21 @@ export interface Routes {
3949
4090
  method: 'PATCH' | 'POST';
3950
4091
  queryParams: {};
3951
4092
  jsonBody: {
4093
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
3952
4094
  access_schedule?: ({
3953
4095
  starts_at: string;
3954
4096
  ends_at: string;
3955
4097
  } | null) | undefined;
4098
+ /** ID of the `acs_user`. */
3956
4099
  acs_user_id: string;
4100
+ /** Full name of the `acs_user`. */
3957
4101
  full_name?: string | undefined;
3958
4102
  /**
3959
4103
  * @deprecated use email_address. */
3960
4104
  email?: string | undefined;
4105
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
3961
4106
  phone_number?: string | undefined;
4107
+ /** Email address of the `acs_user`. */
3962
4108
  email_address?: string | undefined;
3963
4109
  hid_acs_system_id?: string | undefined;
3964
4110
  };
@@ -16074,25 +16220,41 @@ export interface Routes {
16074
16220
  formData: {};
16075
16221
  jsonResponse: {
16076
16222
  acs_users: Array<{
16223
+ /** ID of the `acs_user`. */
16077
16224
  acs_user_id: string;
16225
+ /** ID of the access control system that contains the `acs_user`. */
16078
16226
  acs_system_id: string;
16079
16227
  hid_acs_system_id?: string | undefined;
16228
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
16080
16229
  workspace_id: string;
16230
+ /** Date and time at which the `acs_user` was created. */
16081
16231
  created_at: string;
16232
+ /** Display name for the `acs_user`. */
16082
16233
  display_name: string;
16234
+ /** Brand-specific terminology for the `acs_user` type. */
16083
16235
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
16236
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
16084
16237
  external_type_display_name?: string | undefined;
16238
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
16085
16239
  is_suspended: boolean;
16240
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
16086
16241
  access_schedule?: {
16087
16242
  starts_at: string;
16088
16243
  ends_at: string;
16089
16244
  } | undefined;
16245
+ /** ID of the user identity associated with the `acs_user`. */
16090
16246
  user_identity_id?: string | undefined;
16247
+ /** Full name of the user identity associated with the `acs_user`. */
16091
16248
  user_identity_full_name?: (string | null) | undefined;
16249
+ /** Email address of the user identity associated with the `acs_user`. */
16092
16250
  user_identity_email_address?: (string | null) | undefined;
16251
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
16093
16252
  user_identity_phone_number?: (string | null) | undefined;
16253
+ /** */
16094
16254
  latest_desired_state_synced_with_provider_at?: string | undefined;
16255
+ /** */
16095
16256
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
16257
+ /** Warnings associated with the `acs_user`. */
16096
16258
  warnings: Array<{
16097
16259
  created_at: string;
16098
16260
  message: string;
@@ -16102,6 +16264,7 @@ export interface Routes {
16102
16264
  message: string;
16103
16265
  warning_code: 'salto_ks_user_not_subscribed';
16104
16266
  }>;
16267
+ /** Errors associated with the `acs_user`. */
16105
16268
  errors: Array<{
16106
16269
  /** Date and time at which Seam created the error. */
16107
16270
  created_at: string;
@@ -16133,11 +16296,14 @@ export interface Routes {
16133
16296
  message: string;
16134
16297
  error_code: 'failed_to_delete_on_acs_system';
16135
16298
  }>;
16299
+ /** Full name of the `acs_user`. */
16136
16300
  full_name?: string | undefined;
16137
16301
  /**
16138
16302
  * @deprecated use email_address. */
16139
16303
  email?: string | undefined;
16304
+ /** Email address of the `acs_user`. */
16140
16305
  email_address?: string | undefined;
16306
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
16141
16307
  phone_number?: string | undefined;
16142
16308
  is_managed: true;
16143
16309
  }>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.245.1",
3
+ "version": "1.247.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -92,7 +92,7 @@
92
92
  "zod": "^3.21.4"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.19.0",
95
+ "@seamapi/blueprint": "^0.21.0",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",