@seamapi/types 1.246.0 → 1.247.1

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.
@@ -9971,6 +9971,7 @@ declare const _default: {
9971
9971
  acs_user: {
9972
9972
  properties: {
9973
9973
  access_schedule: {
9974
+ description: string;
9974
9975
  properties: {
9975
9976
  ends_at: {
9976
9977
  format: string;
@@ -9985,18 +9986,22 @@ declare const _default: {
9985
9986
  type: string;
9986
9987
  };
9987
9988
  acs_system_id: {
9989
+ description: string;
9988
9990
  format: string;
9989
9991
  type: string;
9990
9992
  };
9991
9993
  acs_user_id: {
9994
+ description: string;
9992
9995
  format: string;
9993
9996
  type: string;
9994
9997
  };
9995
9998
  created_at: {
9999
+ description: string;
9996
10000
  format: string;
9997
10001
  type: string;
9998
10002
  };
9999
10003
  display_name: {
10004
+ description: string;
10000
10005
  type: string;
10001
10006
  };
10002
10007
  email: {
@@ -10006,10 +10011,12 @@ declare const _default: {
10006
10011
  'x-deprecated': string;
10007
10012
  };
10008
10013
  email_address: {
10014
+ description: string;
10009
10015
  format: string;
10010
10016
  type: string;
10011
10017
  };
10012
10018
  errors: {
10019
+ description: string;
10013
10020
  items: {
10014
10021
  description: string;
10015
10022
  oneOf: {
@@ -10036,13 +10043,16 @@ declare const _default: {
10036
10043
  type: string;
10037
10044
  };
10038
10045
  external_type: {
10046
+ description: string;
10039
10047
  enum: string[];
10040
10048
  type: string;
10041
10049
  };
10042
10050
  external_type_display_name: {
10051
+ description: string;
10043
10052
  type: string;
10044
10053
  };
10045
10054
  full_name: {
10055
+ description: string;
10046
10056
  type: string;
10047
10057
  };
10048
10058
  hid_acs_system_id: {
@@ -10051,37 +10061,46 @@ declare const _default: {
10051
10061
  };
10052
10062
  is_latest_desired_state_synced_with_provider: {
10053
10063
  type: string;
10064
+ 'x-undocumented': string;
10054
10065
  };
10055
10066
  is_managed: {
10056
10067
  enum: boolean[];
10057
10068
  type: string;
10058
10069
  };
10059
10070
  is_suspended: {
10071
+ description: string;
10060
10072
  type: string;
10061
10073
  };
10062
10074
  latest_desired_state_synced_with_provider_at: {
10063
10075
  format: string;
10064
10076
  type: string;
10077
+ 'x-undocumented': string;
10065
10078
  };
10066
10079
  phone_number: {
10080
+ description: string;
10067
10081
  type: string;
10068
10082
  };
10069
10083
  user_identity_email_address: {
10084
+ description: string;
10070
10085
  nullable: boolean;
10071
10086
  type: string;
10072
10087
  };
10073
10088
  user_identity_full_name: {
10089
+ description: string;
10074
10090
  nullable: boolean;
10075
10091
  type: string;
10076
10092
  };
10077
10093
  user_identity_id: {
10094
+ description: string;
10078
10095
  type: string;
10079
10096
  };
10080
10097
  user_identity_phone_number: {
10098
+ description: string;
10081
10099
  nullable: boolean;
10082
10100
  type: string;
10083
10101
  };
10084
10102
  warnings: {
10103
+ description: string;
10085
10104
  items: {
10086
10105
  description: string;
10087
10106
  oneOf: {
@@ -10106,6 +10125,7 @@ declare const _default: {
10106
10125
  type: string;
10107
10126
  };
10108
10127
  workspace_id: {
10128
+ description: string;
10109
10129
  format: string;
10110
10130
  type: string;
10111
10131
  };
@@ -17742,13 +17762,16 @@ declare const _default: {
17742
17762
  'x-deprecated': string;
17743
17763
  };
17744
17764
  email_address: {
17765
+ description: string;
17745
17766
  format: string;
17746
17767
  type: string;
17747
17768
  };
17748
17769
  full_name: {
17770
+ description: string;
17749
17771
  type: string;
17750
17772
  };
17751
17773
  phone_number: {
17774
+ description: string;
17752
17775
  type: string;
17753
17776
  };
17754
17777
  user_identity_id: {
@@ -18358,21 +18381,37 @@ declare const _default: {
18358
18381
  acs_user: {
18359
18382
  properties: {
18360
18383
  access_schedule: {
18361
- $ref: string;
18384
+ description: string;
18385
+ properties: {
18386
+ ends_at: {
18387
+ format: string;
18388
+ type: string;
18389
+ };
18390
+ starts_at: {
18391
+ format: string;
18392
+ type: string;
18393
+ };
18394
+ };
18395
+ required: string[];
18396
+ type: string;
18362
18397
  };
18363
18398
  acs_system_id: {
18399
+ description: string;
18364
18400
  format: string;
18365
18401
  type: string;
18366
18402
  };
18367
18403
  acs_user_id: {
18404
+ description: string;
18368
18405
  format: string;
18369
18406
  type: string;
18370
18407
  };
18371
18408
  created_at: {
18409
+ description: string;
18372
18410
  format: string;
18373
18411
  type: string;
18374
18412
  };
18375
18413
  display_name: {
18414
+ description: string;
18376
18415
  type: string;
18377
18416
  };
18378
18417
  email: {
@@ -18382,10 +18421,12 @@ declare const _default: {
18382
18421
  'x-deprecated': string;
18383
18422
  };
18384
18423
  email_address: {
18424
+ description: string;
18385
18425
  format: string;
18386
18426
  type: string;
18387
18427
  };
18388
18428
  errors: {
18429
+ description: string;
18389
18430
  items: {
18390
18431
  description: string;
18391
18432
  oneOf: {
@@ -18412,13 +18453,16 @@ declare const _default: {
18412
18453
  type: string;
18413
18454
  };
18414
18455
  external_type: {
18456
+ description: string;
18415
18457
  enum: string[];
18416
18458
  type: string;
18417
18459
  };
18418
18460
  external_type_display_name: {
18461
+ description: string;
18419
18462
  type: string;
18420
18463
  };
18421
18464
  full_name: {
18465
+ description: string;
18422
18466
  type: string;
18423
18467
  };
18424
18468
  hid_acs_system_id: {
@@ -18427,37 +18471,46 @@ declare const _default: {
18427
18471
  };
18428
18472
  is_latest_desired_state_synced_with_provider: {
18429
18473
  type: string;
18474
+ 'x-undocumented': string;
18430
18475
  };
18431
18476
  is_managed: {
18432
18477
  enum: boolean[];
18433
18478
  type: string;
18434
18479
  };
18435
18480
  is_suspended: {
18481
+ description: string;
18436
18482
  type: string;
18437
18483
  };
18438
18484
  latest_desired_state_synced_with_provider_at: {
18439
18485
  format: string;
18440
18486
  type: string;
18487
+ 'x-undocumented': string;
18441
18488
  };
18442
18489
  phone_number: {
18490
+ description: string;
18443
18491
  type: string;
18444
18492
  };
18445
18493
  user_identity_email_address: {
18494
+ description: string;
18446
18495
  nullable: boolean;
18447
18496
  type: string;
18448
18497
  };
18449
18498
  user_identity_full_name: {
18499
+ description: string;
18450
18500
  nullable: boolean;
18451
18501
  type: string;
18452
18502
  };
18453
18503
  user_identity_id: {
18504
+ description: string;
18454
18505
  type: string;
18455
18506
  };
18456
18507
  user_identity_phone_number: {
18508
+ description: string;
18457
18509
  nullable: boolean;
18458
18510
  type: string;
18459
18511
  };
18460
18512
  warnings: {
18513
+ description: string;
18461
18514
  items: {
18462
18515
  description: string;
18463
18516
  oneOf: {
@@ -18482,6 +18535,7 @@ declare const _default: {
18482
18535
  type: string;
18483
18536
  };
18484
18537
  workspace_id: {
18538
+ description: string;
18485
18539
  format: string;
18486
18540
  type: string;
18487
18541
  };
@@ -18571,21 +18625,37 @@ declare const _default: {
18571
18625
  items: {
18572
18626
  properties: {
18573
18627
  access_schedule: {
18574
- $ref: string;
18628
+ description: string;
18629
+ properties: {
18630
+ ends_at: {
18631
+ format: string;
18632
+ type: string;
18633
+ };
18634
+ starts_at: {
18635
+ format: string;
18636
+ type: string;
18637
+ };
18638
+ };
18639
+ required: string[];
18640
+ type: string;
18575
18641
  };
18576
18642
  acs_system_id: {
18643
+ description: string;
18577
18644
  format: string;
18578
18645
  type: string;
18579
18646
  };
18580
18647
  acs_user_id: {
18648
+ description: string;
18581
18649
  format: string;
18582
18650
  type: string;
18583
18651
  };
18584
18652
  created_at: {
18653
+ description: string;
18585
18654
  format: string;
18586
18655
  type: string;
18587
18656
  };
18588
18657
  display_name: {
18658
+ description: string;
18589
18659
  type: string;
18590
18660
  };
18591
18661
  email: {
@@ -18595,10 +18665,12 @@ declare const _default: {
18595
18665
  'x-deprecated': string;
18596
18666
  };
18597
18667
  email_address: {
18668
+ description: string;
18598
18669
  format: string;
18599
18670
  type: string;
18600
18671
  };
18601
18672
  errors: {
18673
+ description: string;
18602
18674
  items: {
18603
18675
  description: string;
18604
18676
  oneOf: {
@@ -18625,13 +18697,16 @@ declare const _default: {
18625
18697
  type: string;
18626
18698
  };
18627
18699
  external_type: {
18700
+ description: string;
18628
18701
  enum: string[];
18629
18702
  type: string;
18630
18703
  };
18631
18704
  external_type_display_name: {
18705
+ description: string;
18632
18706
  type: string;
18633
18707
  };
18634
18708
  full_name: {
18709
+ description: string;
18635
18710
  type: string;
18636
18711
  };
18637
18712
  hid_acs_system_id: {
@@ -18640,37 +18715,46 @@ declare const _default: {
18640
18715
  };
18641
18716
  is_latest_desired_state_synced_with_provider: {
18642
18717
  type: string;
18718
+ 'x-undocumented': string;
18643
18719
  };
18644
18720
  is_managed: {
18645
18721
  enum: boolean[];
18646
18722
  type: string;
18647
18723
  };
18648
18724
  is_suspended: {
18725
+ description: string;
18649
18726
  type: string;
18650
18727
  };
18651
18728
  latest_desired_state_synced_with_provider_at: {
18652
18729
  format: string;
18653
18730
  type: string;
18731
+ 'x-undocumented': string;
18654
18732
  };
18655
18733
  phone_number: {
18734
+ description: string;
18656
18735
  type: string;
18657
18736
  };
18658
18737
  user_identity_email_address: {
18738
+ description: string;
18659
18739
  nullable: boolean;
18660
18740
  type: string;
18661
18741
  };
18662
18742
  user_identity_full_name: {
18743
+ description: string;
18663
18744
  nullable: boolean;
18664
18745
  type: string;
18665
18746
  };
18666
18747
  user_identity_id: {
18748
+ description: string;
18667
18749
  type: string;
18668
18750
  };
18669
18751
  user_identity_phone_number: {
18752
+ description: string;
18670
18753
  nullable: boolean;
18671
18754
  type: string;
18672
18755
  };
18673
18756
  warnings: {
18757
+ description: string;
18674
18758
  items: {
18675
18759
  description: string;
18676
18760
  oneOf: {
@@ -18695,6 +18779,7 @@ declare const _default: {
18695
18779
  type: string;
18696
18780
  };
18697
18781
  workspace_id: {
18782
+ description: string;
18698
18783
  format: string;
18699
18784
  type: string;
18700
18785
  };
@@ -18834,6 +18919,7 @@ declare const _default: {
18834
18919
  type: string;
18835
18920
  };
18836
18921
  acs_user_id: {
18922
+ description: string;
18837
18923
  format: string;
18838
18924
  type: string;
18839
18925
  };
@@ -18844,10 +18930,12 @@ declare const _default: {
18844
18930
  'x-deprecated': string;
18845
18931
  };
18846
18932
  email_address: {
18933
+ description: string;
18847
18934
  format: string;
18848
18935
  type: string;
18849
18936
  };
18850
18937
  full_name: {
18938
+ description: string;
18851
18939
  type: string;
18852
18940
  };
18853
18941
  hid_acs_system_id: {
@@ -18855,6 +18943,7 @@ declare const _default: {
18855
18943
  type: string;
18856
18944
  };
18857
18945
  phone_number: {
18946
+ description: string;
18858
18947
  type: string;
18859
18948
  };
18860
18949
  };
@@ -18931,6 +19020,7 @@ declare const _default: {
18931
19020
  type: string;
18932
19021
  };
18933
19022
  acs_user_id: {
19023
+ description: string;
18934
19024
  format: string;
18935
19025
  type: string;
18936
19026
  };
@@ -18941,10 +19031,12 @@ declare const _default: {
18941
19031
  'x-deprecated': string;
18942
19032
  };
18943
19033
  email_address: {
19034
+ description: string;
18944
19035
  format: string;
18945
19036
  type: string;
18946
19037
  };
18947
19038
  full_name: {
19039
+ description: string;
18948
19040
  type: string;
18949
19041
  };
18950
19042
  hid_acs_system_id: {
@@ -18952,6 +19044,7 @@ declare const _default: {
18952
19044
  type: string;
18953
19045
  };
18954
19046
  phone_number: {
19047
+ description: string;
18955
19048
  type: string;
18956
19049
  };
18957
19050
  };
@@ -24556,9 +24649,6 @@ declare const _default: {
24556
24649
  ok: {
24557
24650
  type: string;
24558
24651
  };
24559
- thermostat_schedule: {
24560
- $ref: string;
24561
- };
24562
24652
  };
24563
24653
  required: string[];
24564
24654
  type: string;
@@ -24642,9 +24732,6 @@ declare const _default: {
24642
24732
  ok: {
24643
24733
  type: string;
24644
24734
  };
24645
- thermostat_schedule: {
24646
- $ref: string;
24647
- };
24648
24735
  };
24649
24736
  required: string[];
24650
24737
  type: string;
@@ -24900,9 +24987,6 @@ declare const _default: {
24900
24987
  'application/json': {
24901
24988
  schema: {
24902
24989
  properties: {
24903
- climate_preset: {
24904
- $ref: string;
24905
- };
24906
24990
  ok: {
24907
24991
  type: string;
24908
24992
  };
@@ -24997,9 +25081,6 @@ declare const _default: {
24997
25081
  'application/json': {
24998
25082
  schema: {
24999
25083
  properties: {
25000
- climate_preset: {
25001
- $ref: string;
25002
- };
25003
25084
  ok: {
25004
25085
  type: string;
25005
25086
  };
@@ -29588,25 +29669,41 @@ interface Routes {
29588
29669
  formData: {};
29589
29670
  jsonResponse: {
29590
29671
  acs_users: Array<{
29672
+ /** ID of the `acs_user`. */
29591
29673
  acs_user_id: string;
29674
+ /** ID of the access control system that contains the `acs_user`. */
29592
29675
  acs_system_id: string;
29593
29676
  hid_acs_system_id?: string | undefined;
29677
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
29594
29678
  workspace_id: string;
29679
+ /** Date and time at which the `acs_user` was created. */
29595
29680
  created_at: string;
29681
+ /** Display name for the `acs_user`. */
29596
29682
  display_name: string;
29683
+ /** Brand-specific terminology for the `acs_user` type. */
29597
29684
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
29685
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
29598
29686
  external_type_display_name?: string | undefined;
29687
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
29599
29688
  is_suspended: boolean;
29689
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
29600
29690
  access_schedule?: {
29601
29691
  starts_at: string;
29602
29692
  ends_at: string;
29603
29693
  } | undefined;
29694
+ /** ID of the user identity associated with the `acs_user`. */
29604
29695
  user_identity_id?: string | undefined;
29696
+ /** Full name of the user identity associated with the `acs_user`. */
29605
29697
  user_identity_full_name?: (string | null) | undefined;
29698
+ /** Email address of the user identity associated with the `acs_user`. */
29606
29699
  user_identity_email_address?: (string | null) | undefined;
29700
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
29607
29701
  user_identity_phone_number?: (string | null) | undefined;
29702
+ /** */
29608
29703
  latest_desired_state_synced_with_provider_at?: string | undefined;
29704
+ /** */
29609
29705
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
29706
+ /** Warnings associated with the `acs_user`. */
29610
29707
  warnings: Array<{
29611
29708
  created_at: string;
29612
29709
  message: string;
@@ -29616,6 +29713,7 @@ interface Routes {
29616
29713
  message: string;
29617
29714
  warning_code: 'salto_ks_user_not_subscribed';
29618
29715
  }>;
29716
+ /** Errors associated with the `acs_user`. */
29619
29717
  errors: Array<{
29620
29718
  /** Date and time at which Seam created the error. */
29621
29719
  created_at: string;
@@ -29647,11 +29745,14 @@ interface Routes {
29647
29745
  message: string;
29648
29746
  error_code: 'failed_to_delete_on_acs_system';
29649
29747
  }>;
29748
+ /** Full name of the `acs_user`. */
29650
29749
  full_name?: string | undefined;
29651
29750
  /**
29652
29751
  * @deprecated use email_address. */
29653
29752
  email?: string | undefined;
29753
+ /** Email address of the `acs_user`. */
29654
29754
  email_address?: string | undefined;
29755
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
29655
29756
  phone_number?: string | undefined;
29656
29757
  is_managed: true;
29657
29758
  }>;
@@ -30719,36 +30820,55 @@ interface Routes {
30719
30820
  starts_at: string;
30720
30821
  ends_at: string;
30721
30822
  } | undefined;
30823
+ /** Full name of the `acs_user`. */
30722
30824
  full_name?: string | undefined;
30723
30825
  /**
30724
30826
  * @deprecated use email_address. */
30725
30827
  email?: string | undefined;
30828
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30726
30829
  phone_number?: string | undefined;
30830
+ /** Email address of the `acs_user`. */
30727
30831
  email_address?: string | undefined;
30728
30832
  };
30729
30833
  commonParams: {};
30730
30834
  formData: {};
30731
30835
  jsonResponse: {
30732
30836
  acs_user: {
30837
+ /** ID of the `acs_user`. */
30733
30838
  acs_user_id: string;
30839
+ /** ID of the access control system that contains the `acs_user`. */
30734
30840
  acs_system_id: string;
30735
30841
  hid_acs_system_id?: string | undefined;
30842
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
30736
30843
  workspace_id: string;
30844
+ /** Date and time at which the `acs_user` was created. */
30737
30845
  created_at: string;
30846
+ /** Display name for the `acs_user`. */
30738
30847
  display_name: string;
30848
+ /** Brand-specific terminology for the `acs_user` type. */
30739
30849
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
30850
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
30740
30851
  external_type_display_name?: string | undefined;
30852
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
30741
30853
  is_suspended: boolean;
30854
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
30742
30855
  access_schedule?: {
30743
30856
  starts_at: string;
30744
30857
  ends_at: string;
30745
30858
  } | undefined;
30859
+ /** ID of the user identity associated with the `acs_user`. */
30746
30860
  user_identity_id?: string | undefined;
30861
+ /** Full name of the user identity associated with the `acs_user`. */
30747
30862
  user_identity_full_name?: (string | null) | undefined;
30863
+ /** Email address of the user identity associated with the `acs_user`. */
30748
30864
  user_identity_email_address?: (string | null) | undefined;
30865
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
30749
30866
  user_identity_phone_number?: (string | null) | undefined;
30867
+ /** */
30750
30868
  latest_desired_state_synced_with_provider_at?: string | undefined;
30869
+ /** */
30751
30870
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
30871
+ /** Warnings associated with the `acs_user`. */
30752
30872
  warnings: Array<{
30753
30873
  created_at: string;
30754
30874
  message: string;
@@ -30758,6 +30878,7 @@ interface Routes {
30758
30878
  message: string;
30759
30879
  warning_code: 'salto_ks_user_not_subscribed';
30760
30880
  }>;
30881
+ /** Errors associated with the `acs_user`. */
30761
30882
  errors: Array<{
30762
30883
  /** Date and time at which Seam created the error. */
30763
30884
  created_at: string;
@@ -30789,11 +30910,14 @@ interface Routes {
30789
30910
  message: string;
30790
30911
  error_code: 'failed_to_delete_on_acs_system';
30791
30912
  }>;
30913
+ /** Full name of the `acs_user`. */
30792
30914
  full_name?: string | undefined;
30793
30915
  /**
30794
30916
  * @deprecated use email_address. */
30795
30917
  email?: string | undefined;
30918
+ /** Email address of the `acs_user`. */
30796
30919
  email_address?: string | undefined;
30920
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30797
30921
  phone_number?: string | undefined;
30798
30922
  is_managed: true;
30799
30923
  };
@@ -30823,25 +30947,41 @@ interface Routes {
30823
30947
  formData: {};
30824
30948
  jsonResponse: {
30825
30949
  acs_user: {
30950
+ /** ID of the `acs_user`. */
30826
30951
  acs_user_id: string;
30952
+ /** ID of the access control system that contains the `acs_user`. */
30827
30953
  acs_system_id: string;
30828
30954
  hid_acs_system_id?: string | undefined;
30955
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
30829
30956
  workspace_id: string;
30957
+ /** Date and time at which the `acs_user` was created. */
30830
30958
  created_at: string;
30959
+ /** Display name for the `acs_user`. */
30831
30960
  display_name: string;
30961
+ /** Brand-specific terminology for the `acs_user` type. */
30832
30962
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
30963
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
30833
30964
  external_type_display_name?: string | undefined;
30965
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
30834
30966
  is_suspended: boolean;
30967
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
30835
30968
  access_schedule?: {
30836
30969
  starts_at: string;
30837
30970
  ends_at: string;
30838
30971
  } | undefined;
30972
+ /** ID of the user identity associated with the `acs_user`. */
30839
30973
  user_identity_id?: string | undefined;
30974
+ /** Full name of the user identity associated with the `acs_user`. */
30840
30975
  user_identity_full_name?: (string | null) | undefined;
30976
+ /** Email address of the user identity associated with the `acs_user`. */
30841
30977
  user_identity_email_address?: (string | null) | undefined;
30978
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
30842
30979
  user_identity_phone_number?: (string | null) | undefined;
30980
+ /** */
30843
30981
  latest_desired_state_synced_with_provider_at?: string | undefined;
30982
+ /** */
30844
30983
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
30984
+ /** Warnings associated with the `acs_user`. */
30845
30985
  warnings: Array<{
30846
30986
  created_at: string;
30847
30987
  message: string;
@@ -30851,6 +30991,7 @@ interface Routes {
30851
30991
  message: string;
30852
30992
  warning_code: 'salto_ks_user_not_subscribed';
30853
30993
  }>;
30994
+ /** Errors associated with the `acs_user`. */
30854
30995
  errors: Array<{
30855
30996
  /** Date and time at which Seam created the error. */
30856
30997
  created_at: string;
@@ -30882,11 +31023,14 @@ interface Routes {
30882
31023
  message: string;
30883
31024
  error_code: 'failed_to_delete_on_acs_system';
30884
31025
  }>;
31026
+ /** Full name of the `acs_user`. */
30885
31027
  full_name?: string | undefined;
30886
31028
  /**
30887
31029
  * @deprecated use email_address. */
30888
31030
  email?: string | undefined;
31031
+ /** Email address of the `acs_user`. */
30889
31032
  email_address?: string | undefined;
31033
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30890
31034
  phone_number?: string | undefined;
30891
31035
  is_managed: true;
30892
31036
  };
@@ -30912,25 +31056,41 @@ interface Routes {
30912
31056
  formData: {};
30913
31057
  jsonResponse: {
30914
31058
  acs_users: Array<{
31059
+ /** ID of the `acs_user`. */
30915
31060
  acs_user_id: string;
31061
+ /** ID of the access control system that contains the `acs_user`. */
30916
31062
  acs_system_id: string;
30917
31063
  hid_acs_system_id?: string | undefined;
31064
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
30918
31065
  workspace_id: string;
31066
+ /** Date and time at which the `acs_user` was created. */
30919
31067
  created_at: string;
31068
+ /** Display name for the `acs_user`. */
30920
31069
  display_name: string;
31070
+ /** Brand-specific terminology for the `acs_user` type. */
30921
31071
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
31072
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
30922
31073
  external_type_display_name?: string | undefined;
31074
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
30923
31075
  is_suspended: boolean;
31076
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
30924
31077
  access_schedule?: {
30925
31078
  starts_at: string;
30926
31079
  ends_at: string;
30927
31080
  } | undefined;
31081
+ /** ID of the user identity associated with the `acs_user`. */
30928
31082
  user_identity_id?: string | undefined;
31083
+ /** Full name of the user identity associated with the `acs_user`. */
30929
31084
  user_identity_full_name?: (string | null) | undefined;
31085
+ /** Email address of the user identity associated with the `acs_user`. */
30930
31086
  user_identity_email_address?: (string | null) | undefined;
31087
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
30931
31088
  user_identity_phone_number?: (string | null) | undefined;
31089
+ /** */
30932
31090
  latest_desired_state_synced_with_provider_at?: string | undefined;
31091
+ /** */
30933
31092
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
31093
+ /** Warnings associated with the `acs_user`. */
30934
31094
  warnings: Array<{
30935
31095
  created_at: string;
30936
31096
  message: string;
@@ -30940,6 +31100,7 @@ interface Routes {
30940
31100
  message: string;
30941
31101
  warning_code: 'salto_ks_user_not_subscribed';
30942
31102
  }>;
31103
+ /** Errors associated with the `acs_user`. */
30943
31104
  errors: Array<{
30944
31105
  /** Date and time at which Seam created the error. */
30945
31106
  created_at: string;
@@ -30971,11 +31132,14 @@ interface Routes {
30971
31132
  message: string;
30972
31133
  error_code: 'failed_to_delete_on_acs_system';
30973
31134
  }>;
31135
+ /** Full name of the `acs_user`. */
30974
31136
  full_name?: string | undefined;
30975
31137
  /**
30976
31138
  * @deprecated use email_address. */
30977
31139
  email?: string | undefined;
31140
+ /** Email address of the `acs_user`. */
30978
31141
  email_address?: string | undefined;
31142
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30979
31143
  phone_number?: string | undefined;
30980
31144
  is_managed: true;
30981
31145
  }>;
@@ -31067,25 +31231,41 @@ interface Routes {
31067
31231
  formData: {};
31068
31232
  jsonResponse: {
31069
31233
  acs_user: {
31234
+ /** ID of the `acs_user`. */
31070
31235
  acs_user_id: string;
31236
+ /** ID of the access control system that contains the `acs_user`. */
31071
31237
  acs_system_id: string;
31072
31238
  hid_acs_system_id?: string | undefined;
31239
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
31073
31240
  workspace_id: string;
31241
+ /** Date and time at which the `acs_user` was created. */
31074
31242
  created_at: string;
31243
+ /** Display name for the `acs_user`. */
31075
31244
  display_name: string;
31245
+ /** Brand-specific terminology for the `acs_user` type. */
31076
31246
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
31247
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
31077
31248
  external_type_display_name?: string | undefined;
31249
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
31078
31250
  is_suspended: boolean;
31251
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
31079
31252
  access_schedule?: {
31080
31253
  starts_at: string;
31081
31254
  ends_at: string;
31082
31255
  } | undefined;
31256
+ /** ID of the user identity associated with the `acs_user`. */
31083
31257
  user_identity_id?: string | undefined;
31258
+ /** Full name of the user identity associated with the `acs_user`. */
31084
31259
  user_identity_full_name?: (string | null) | undefined;
31260
+ /** Email address of the user identity associated with the `acs_user`. */
31085
31261
  user_identity_email_address?: (string | null) | undefined;
31262
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
31086
31263
  user_identity_phone_number?: (string | null) | undefined;
31264
+ /** */
31087
31265
  latest_desired_state_synced_with_provider_at?: string | undefined;
31266
+ /** */
31088
31267
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
31268
+ /** Warnings associated with the `acs_user`. */
31089
31269
  warnings: Array<{
31090
31270
  created_at: string;
31091
31271
  message: string;
@@ -31095,6 +31275,7 @@ interface Routes {
31095
31275
  message: string;
31096
31276
  warning_code: 'salto_ks_user_not_subscribed';
31097
31277
  }>;
31278
+ /** Errors associated with the `acs_user`. */
31098
31279
  errors: Array<{
31099
31280
  /** Date and time at which Seam created the error. */
31100
31281
  created_at: string;
@@ -31126,11 +31307,14 @@ interface Routes {
31126
31307
  message: string;
31127
31308
  error_code: 'failed_to_delete_on_acs_system';
31128
31309
  }>;
31310
+ /** Full name of the `acs_user`. */
31129
31311
  full_name?: string | undefined;
31130
31312
  /**
31131
31313
  * @deprecated use email_address. */
31132
31314
  email?: string | undefined;
31315
+ /** Email address of the `acs_user`. */
31133
31316
  email_address?: string | undefined;
31317
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
31134
31318
  phone_number?: string | undefined;
31135
31319
  is_managed: false;
31136
31320
  };
@@ -31151,25 +31335,41 @@ interface Routes {
31151
31335
  formData: {};
31152
31336
  jsonResponse: {
31153
31337
  acs_users: Array<{
31338
+ /** ID of the `acs_user`. */
31154
31339
  acs_user_id: string;
31340
+ /** ID of the access control system that contains the `acs_user`. */
31155
31341
  acs_system_id: string;
31156
31342
  hid_acs_system_id?: string | undefined;
31343
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
31157
31344
  workspace_id: string;
31345
+ /** Date and time at which the `acs_user` was created. */
31158
31346
  created_at: string;
31347
+ /** Display name for the `acs_user`. */
31159
31348
  display_name: string;
31349
+ /** Brand-specific terminology for the `acs_user` type. */
31160
31350
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
31351
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
31161
31352
  external_type_display_name?: string | undefined;
31353
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
31162
31354
  is_suspended: boolean;
31355
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
31163
31356
  access_schedule?: {
31164
31357
  starts_at: string;
31165
31358
  ends_at: string;
31166
31359
  } | undefined;
31360
+ /** ID of the user identity associated with the `acs_user`. */
31167
31361
  user_identity_id?: string | undefined;
31362
+ /** Full name of the user identity associated with the `acs_user`. */
31168
31363
  user_identity_full_name?: (string | null) | undefined;
31364
+ /** Email address of the user identity associated with the `acs_user`. */
31169
31365
  user_identity_email_address?: (string | null) | undefined;
31366
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
31170
31367
  user_identity_phone_number?: (string | null) | undefined;
31368
+ /** */
31171
31369
  latest_desired_state_synced_with_provider_at?: string | undefined;
31370
+ /** */
31172
31371
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
31372
+ /** Warnings associated with the `acs_user`. */
31173
31373
  warnings: Array<{
31174
31374
  created_at: string;
31175
31375
  message: string;
@@ -31179,6 +31379,7 @@ interface Routes {
31179
31379
  message: string;
31180
31380
  warning_code: 'salto_ks_user_not_subscribed';
31181
31381
  }>;
31382
+ /** Errors associated with the `acs_user`. */
31182
31383
  errors: Array<{
31183
31384
  /** Date and time at which Seam created the error. */
31184
31385
  created_at: string;
@@ -31210,11 +31411,14 @@ interface Routes {
31210
31411
  message: string;
31211
31412
  error_code: 'failed_to_delete_on_acs_system';
31212
31413
  }>;
31414
+ /** Full name of the `acs_user`. */
31213
31415
  full_name?: string | undefined;
31214
31416
  /**
31215
31417
  * @deprecated use email_address. */
31216
31418
  email?: string | undefined;
31419
+ /** Email address of the `acs_user`. */
31217
31420
  email_address?: string | undefined;
31421
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
31218
31422
  phone_number?: string | undefined;
31219
31423
  is_managed: false;
31220
31424
  }>;
@@ -31242,12 +31446,16 @@ interface Routes {
31242
31446
  starts_at: string;
31243
31447
  ends_at: string;
31244
31448
  } | null) | undefined;
31449
+ /** ID of the `acs_user`. */
31245
31450
  acs_user_id: string;
31451
+ /** Full name of the `acs_user`. */
31246
31452
  full_name?: string | undefined;
31247
31453
  /**
31248
31454
  * @deprecated use email_address. */
31249
31455
  email?: string | undefined;
31456
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
31250
31457
  phone_number?: string | undefined;
31458
+ /** Email address of the `acs_user`. */
31251
31459
  email_address?: string | undefined;
31252
31460
  hid_acs_system_id?: string | undefined;
31253
31461
  };
@@ -41733,20 +41941,7 @@ interface Routes {
41733
41941
  };
41734
41942
  commonParams: {};
41735
41943
  formData: {};
41736
- jsonResponse: {
41737
- thermostat_schedule: {
41738
- thermostat_schedule_id: string;
41739
- device_id: string;
41740
- name?: string | undefined;
41741
- climate_preset_key: string;
41742
- max_override_period_minutes?: number;
41743
- starts_at: string;
41744
- ends_at: string;
41745
- created_at: string;
41746
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
41747
- errors?: any;
41748
- };
41749
- };
41944
+ jsonResponse: {};
41750
41945
  };
41751
41946
  '/thermostats/set_fallback_climate_preset': {
41752
41947
  route: '/thermostats/set_fallback_climate_preset';
@@ -42180,22 +42375,7 @@ interface Routes {
42180
42375
  };
42181
42376
  commonParams: {};
42182
42377
  formData: {};
42183
- jsonResponse: {
42184
- climate_preset: {
42185
- climate_preset_key: string;
42186
- can_edit: boolean;
42187
- can_delete: boolean;
42188
- name?: string | null;
42189
- display_name: string;
42190
- fan_mode_setting?: ('auto' | 'on') | undefined;
42191
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
42192
- cooling_set_point_celsius?: number | undefined;
42193
- heating_set_point_celsius?: number | undefined;
42194
- cooling_set_point_fahrenheit?: number | undefined;
42195
- heating_set_point_fahrenheit?: number | undefined;
42196
- manual_override_allowed: boolean;
42197
- };
42198
- };
42378
+ jsonResponse: {};
42199
42379
  };
42200
42380
  '/user_identities/add_acs_user': {
42201
42381
  route: '/user_identities/add_acs_user';
@@ -43363,25 +43543,41 @@ interface Routes {
43363
43543
  formData: {};
43364
43544
  jsonResponse: {
43365
43545
  acs_users: Array<{
43546
+ /** ID of the `acs_user`. */
43366
43547
  acs_user_id: string;
43548
+ /** ID of the access control system that contains the `acs_user`. */
43367
43549
  acs_system_id: string;
43368
43550
  hid_acs_system_id?: string | undefined;
43551
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
43369
43552
  workspace_id: string;
43553
+ /** Date and time at which the `acs_user` was created. */
43370
43554
  created_at: string;
43555
+ /** Display name for the `acs_user`. */
43371
43556
  display_name: string;
43557
+ /** Brand-specific terminology for the `acs_user` type. */
43372
43558
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
43559
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
43373
43560
  external_type_display_name?: string | undefined;
43561
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
43374
43562
  is_suspended: boolean;
43563
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
43375
43564
  access_schedule?: {
43376
43565
  starts_at: string;
43377
43566
  ends_at: string;
43378
43567
  } | undefined;
43568
+ /** ID of the user identity associated with the `acs_user`. */
43379
43569
  user_identity_id?: string | undefined;
43570
+ /** Full name of the user identity associated with the `acs_user`. */
43380
43571
  user_identity_full_name?: (string | null) | undefined;
43572
+ /** Email address of the user identity associated with the `acs_user`. */
43381
43573
  user_identity_email_address?: (string | null) | undefined;
43574
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
43382
43575
  user_identity_phone_number?: (string | null) | undefined;
43576
+ /** */
43383
43577
  latest_desired_state_synced_with_provider_at?: string | undefined;
43578
+ /** */
43384
43579
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
43580
+ /** Warnings associated with the `acs_user`. */
43385
43581
  warnings: Array<{
43386
43582
  created_at: string;
43387
43583
  message: string;
@@ -43391,6 +43587,7 @@ interface Routes {
43391
43587
  message: string;
43392
43588
  warning_code: 'salto_ks_user_not_subscribed';
43393
43589
  }>;
43590
+ /** Errors associated with the `acs_user`. */
43394
43591
  errors: Array<{
43395
43592
  /** Date and time at which Seam created the error. */
43396
43593
  created_at: string;
@@ -43422,11 +43619,14 @@ interface Routes {
43422
43619
  message: string;
43423
43620
  error_code: 'failed_to_delete_on_acs_system';
43424
43621
  }>;
43622
+ /** Full name of the `acs_user`. */
43425
43623
  full_name?: string | undefined;
43426
43624
  /**
43427
43625
  * @deprecated use email_address. */
43428
43626
  email?: string | undefined;
43627
+ /** Email address of the `acs_user`. */
43429
43628
  email_address?: string | undefined;
43629
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
43430
43630
  phone_number?: string | undefined;
43431
43631
  is_managed: true;
43432
43632
  }>;