@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.
Files changed (13) hide show
  1. package/dist/connect.cjs +448 -103
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +313 -2
  4. package/lib/seam/connect/models/acs/acs-user.js +72 -20
  5. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  6. package/lib/seam/connect/openapi.d.ts +147 -2
  7. package/lib/seam/connect/openapi.js +387 -68
  8. package/lib/seam/connect/openapi.js.map +1 -1
  9. package/lib/seam/connect/route-types.d.ts +166 -0
  10. package/package.json +2 -2
  11. package/src/lib/seam/connect/models/acs/acs-user.ts +90 -20
  12. package/src/lib/seam/connect/openapi.ts +450 -68
  13. package/src/lib/seam/connect/route-types.ts +166 -0
package/dist/connect.d.cts CHANGED
@@ -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
  };
@@ -17562,6 +17582,7 @@ declare const _default: {
17562
17582
  };
17563
17583
  '/acs/users/add_to_access_group': {
17564
17584
  post: {
17585
+ description: string;
17565
17586
  operationId: string;
17566
17587
  requestBody: {
17567
17588
  content: {
@@ -17569,10 +17590,12 @@ declare const _default: {
17569
17590
  schema: {
17570
17591
  properties: {
17571
17592
  acs_access_group_id: {
17593
+ description: string;
17572
17594
  format: string;
17573
17595
  type: string;
17574
17596
  };
17575
17597
  acs_user_id: {
17598
+ description: string;
17576
17599
  format: string;
17577
17600
  type: string;
17578
17601
  };
@@ -17624,8 +17647,10 @@ declare const _default: {
17624
17647
  tags: string[];
17625
17648
  'x-fern-sdk-group-name': string[];
17626
17649
  'x-fern-sdk-method-name': string;
17650
+ 'x-title': string;
17627
17651
  };
17628
17652
  put: {
17653
+ description: string;
17629
17654
  operationId: string;
17630
17655
  requestBody: {
17631
17656
  content: {
@@ -17633,10 +17658,12 @@ declare const _default: {
17633
17658
  schema: {
17634
17659
  properties: {
17635
17660
  acs_access_group_id: {
17661
+ description: string;
17636
17662
  format: string;
17637
17663
  type: string;
17638
17664
  };
17639
17665
  acs_user_id: {
17666
+ description: string;
17640
17667
  format: string;
17641
17668
  type: string;
17642
17669
  };
@@ -17687,10 +17714,12 @@ declare const _default: {
17687
17714
  summary: string;
17688
17715
  tags: string[];
17689
17716
  'x-fern-ignore': boolean;
17717
+ 'x-title': string;
17690
17718
  };
17691
17719
  };
17692
17720
  '/acs/users/create': {
17693
17721
  post: {
17722
+ description: string;
17694
17723
  operationId: string;
17695
17724
  requestBody: {
17696
17725
  content: {
@@ -17698,6 +17727,7 @@ declare const _default: {
17698
17727
  schema: {
17699
17728
  properties: {
17700
17729
  access_schedule: {
17730
+ description: string;
17701
17731
  properties: {
17702
17732
  ends_at: {
17703
17733
  format: string;
@@ -17713,6 +17743,7 @@ declare const _default: {
17713
17743
  };
17714
17744
  acs_access_group_ids: {
17715
17745
  default: never[];
17746
+ description: string;
17716
17747
  items: {
17717
17748
  format: string;
17718
17749
  type: string;
@@ -17720,6 +17751,7 @@ declare const _default: {
17720
17751
  type: string;
17721
17752
  };
17722
17753
  acs_system_id: {
17754
+ description: string;
17723
17755
  format: string;
17724
17756
  type: string;
17725
17757
  };
@@ -17730,16 +17762,20 @@ declare const _default: {
17730
17762
  'x-deprecated': string;
17731
17763
  };
17732
17764
  email_address: {
17765
+ description: string;
17733
17766
  format: string;
17734
17767
  type: string;
17735
17768
  };
17736
17769
  full_name: {
17770
+ description: string;
17737
17771
  type: string;
17738
17772
  };
17739
17773
  phone_number: {
17774
+ description: string;
17740
17775
  type: string;
17741
17776
  };
17742
17777
  user_identity_id: {
17778
+ description: string;
17743
17779
  format: string;
17744
17780
  type: string;
17745
17781
  };
@@ -17795,10 +17831,13 @@ declare const _default: {
17795
17831
  'x-fern-sdk-group-name': string[];
17796
17832
  'x-fern-sdk-method-name': string;
17797
17833
  'x-fern-sdk-return-value': string;
17834
+ 'x-response-key': string;
17835
+ 'x-title': string;
17798
17836
  };
17799
17837
  };
17800
17838
  '/acs/users/delete': {
17801
17839
  post: {
17840
+ description: string;
17802
17841
  operationId: string;
17803
17842
  requestBody: {
17804
17843
  content: {
@@ -17806,6 +17845,7 @@ declare const _default: {
17806
17845
  schema: {
17807
17846
  properties: {
17808
17847
  acs_user_id: {
17848
+ description: string;
17809
17849
  format: string;
17810
17850
  type: string;
17811
17851
  };
@@ -17857,10 +17897,12 @@ declare const _default: {
17857
17897
  tags: string[];
17858
17898
  'x-fern-sdk-group-name': string[];
17859
17899
  'x-fern-sdk-method-name': string;
17900
+ 'x-title': string;
17860
17901
  };
17861
17902
  };
17862
17903
  '/acs/users/get': {
17863
17904
  post: {
17905
+ description: string;
17864
17906
  operationId: string;
17865
17907
  requestBody: {
17866
17908
  content: {
@@ -17868,6 +17910,7 @@ declare const _default: {
17868
17910
  schema: {
17869
17911
  properties: {
17870
17912
  acs_user_id: {
17913
+ description: string;
17871
17914
  format: string;
17872
17915
  type: string;
17873
17916
  };
@@ -17923,10 +17966,13 @@ declare const _default: {
17923
17966
  'x-fern-sdk-group-name': string[];
17924
17967
  'x-fern-sdk-method-name': string;
17925
17968
  'x-fern-sdk-return-value': string;
17969
+ 'x-response-key': string;
17970
+ 'x-title': string;
17926
17971
  };
17927
17972
  };
17928
17973
  '/acs/users/list': {
17929
17974
  post: {
17975
+ description: string;
17930
17976
  operationId: string;
17931
17977
  requestBody: {
17932
17978
  content: {
@@ -17934,6 +17980,7 @@ declare const _default: {
17934
17980
  schema: {
17935
17981
  properties: {
17936
17982
  acs_system_id: {
17983
+ description: string;
17937
17984
  format: string;
17938
17985
  type: string;
17939
17986
  };
@@ -17947,13 +17994,16 @@ declare const _default: {
17947
17994
  type: string;
17948
17995
  };
17949
17996
  user_identity_email_address: {
17997
+ description: string;
17950
17998
  type: string;
17951
17999
  };
17952
18000
  user_identity_id: {
18001
+ description: string;
17953
18002
  format: string;
17954
18003
  type: string;
17955
18004
  };
17956
18005
  user_identity_phone_number: {
18006
+ description: string;
17957
18007
  type: string;
17958
18008
  };
17959
18009
  };
@@ -18018,10 +18068,13 @@ declare const _default: {
18018
18068
  'x-fern-sdk-group-name': string[];
18019
18069
  'x-fern-sdk-method-name': string;
18020
18070
  'x-fern-sdk-return-value': string;
18071
+ 'x-response-key': string;
18072
+ 'x-title': string;
18021
18073
  };
18022
18074
  };
18023
18075
  '/acs/users/list_accessible_entrances': {
18024
18076
  post: {
18077
+ description: string;
18025
18078
  operationId: string;
18026
18079
  requestBody: {
18027
18080
  content: {
@@ -18029,6 +18082,7 @@ declare const _default: {
18029
18082
  schema: {
18030
18083
  properties: {
18031
18084
  acs_user_id: {
18085
+ description: string;
18032
18086
  format: string;
18033
18087
  type: string;
18034
18088
  };
@@ -18095,10 +18149,13 @@ declare const _default: {
18095
18149
  'x-fern-sdk-group-name': string[];
18096
18150
  'x-fern-sdk-method-name': string;
18097
18151
  'x-fern-sdk-return-value': string;
18152
+ 'x-response-key': string;
18153
+ 'x-title': string;
18098
18154
  };
18099
18155
  };
18100
18156
  '/acs/users/remove_from_access_group': {
18101
18157
  post: {
18158
+ description: string;
18102
18159
  operationId: string;
18103
18160
  requestBody: {
18104
18161
  content: {
@@ -18106,10 +18163,12 @@ declare const _default: {
18106
18163
  schema: {
18107
18164
  properties: {
18108
18165
  acs_access_group_id: {
18166
+ description: string;
18109
18167
  format: string;
18110
18168
  type: string;
18111
18169
  };
18112
18170
  acs_user_id: {
18171
+ description: string;
18113
18172
  format: string;
18114
18173
  type: string;
18115
18174
  };
@@ -18161,10 +18220,12 @@ declare const _default: {
18161
18220
  tags: string[];
18162
18221
  'x-fern-sdk-group-name': string[];
18163
18222
  'x-fern-sdk-method-name': string;
18223
+ 'x-title': string;
18164
18224
  };
18165
18225
  };
18166
18226
  '/acs/users/revoke_access_to_all_entrances': {
18167
18227
  post: {
18228
+ description: string;
18168
18229
  operationId: string;
18169
18230
  requestBody: {
18170
18231
  content: {
@@ -18172,6 +18233,7 @@ declare const _default: {
18172
18233
  schema: {
18173
18234
  properties: {
18174
18235
  acs_user_id: {
18236
+ description: string;
18175
18237
  format: string;
18176
18238
  type: string;
18177
18239
  };
@@ -18223,10 +18285,12 @@ declare const _default: {
18223
18285
  tags: string[];
18224
18286
  'x-fern-sdk-group-name': string[];
18225
18287
  'x-fern-sdk-method-name': string;
18288
+ 'x-title': string;
18226
18289
  };
18227
18290
  };
18228
18291
  '/acs/users/suspend': {
18229
18292
  post: {
18293
+ description: string;
18230
18294
  operationId: string;
18231
18295
  requestBody: {
18232
18296
  content: {
@@ -18234,6 +18298,7 @@ declare const _default: {
18234
18298
  schema: {
18235
18299
  properties: {
18236
18300
  acs_user_id: {
18301
+ description: string;
18237
18302
  format: string;
18238
18303
  type: string;
18239
18304
  };
@@ -18285,6 +18350,7 @@ declare const _default: {
18285
18350
  tags: string[];
18286
18351
  'x-fern-sdk-group-name': string[];
18287
18352
  'x-fern-sdk-method-name': string;
18353
+ 'x-title': string;
18288
18354
  };
18289
18355
  };
18290
18356
  '/acs/users/unmanaged/get': {
@@ -18315,21 +18381,37 @@ declare const _default: {
18315
18381
  acs_user: {
18316
18382
  properties: {
18317
18383
  access_schedule: {
18318
- $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;
18319
18397
  };
18320
18398
  acs_system_id: {
18399
+ description: string;
18321
18400
  format: string;
18322
18401
  type: string;
18323
18402
  };
18324
18403
  acs_user_id: {
18404
+ description: string;
18325
18405
  format: string;
18326
18406
  type: string;
18327
18407
  };
18328
18408
  created_at: {
18409
+ description: string;
18329
18410
  format: string;
18330
18411
  type: string;
18331
18412
  };
18332
18413
  display_name: {
18414
+ description: string;
18333
18415
  type: string;
18334
18416
  };
18335
18417
  email: {
@@ -18339,10 +18421,12 @@ declare const _default: {
18339
18421
  'x-deprecated': string;
18340
18422
  };
18341
18423
  email_address: {
18424
+ description: string;
18342
18425
  format: string;
18343
18426
  type: string;
18344
18427
  };
18345
18428
  errors: {
18429
+ description: string;
18346
18430
  items: {
18347
18431
  description: string;
18348
18432
  oneOf: {
@@ -18369,13 +18453,16 @@ declare const _default: {
18369
18453
  type: string;
18370
18454
  };
18371
18455
  external_type: {
18456
+ description: string;
18372
18457
  enum: string[];
18373
18458
  type: string;
18374
18459
  };
18375
18460
  external_type_display_name: {
18461
+ description: string;
18376
18462
  type: string;
18377
18463
  };
18378
18464
  full_name: {
18465
+ description: string;
18379
18466
  type: string;
18380
18467
  };
18381
18468
  hid_acs_system_id: {
@@ -18384,37 +18471,46 @@ declare const _default: {
18384
18471
  };
18385
18472
  is_latest_desired_state_synced_with_provider: {
18386
18473
  type: string;
18474
+ 'x-undocumented': string;
18387
18475
  };
18388
18476
  is_managed: {
18389
18477
  enum: boolean[];
18390
18478
  type: string;
18391
18479
  };
18392
18480
  is_suspended: {
18481
+ description: string;
18393
18482
  type: string;
18394
18483
  };
18395
18484
  latest_desired_state_synced_with_provider_at: {
18396
18485
  format: string;
18397
18486
  type: string;
18487
+ 'x-undocumented': string;
18398
18488
  };
18399
18489
  phone_number: {
18490
+ description: string;
18400
18491
  type: string;
18401
18492
  };
18402
18493
  user_identity_email_address: {
18494
+ description: string;
18403
18495
  nullable: boolean;
18404
18496
  type: string;
18405
18497
  };
18406
18498
  user_identity_full_name: {
18499
+ description: string;
18407
18500
  nullable: boolean;
18408
18501
  type: string;
18409
18502
  };
18410
18503
  user_identity_id: {
18504
+ description: string;
18411
18505
  type: string;
18412
18506
  };
18413
18507
  user_identity_phone_number: {
18508
+ description: string;
18414
18509
  nullable: boolean;
18415
18510
  type: string;
18416
18511
  };
18417
18512
  warnings: {
18513
+ description: string;
18418
18514
  items: {
18419
18515
  description: string;
18420
18516
  oneOf: {
@@ -18439,6 +18535,7 @@ declare const _default: {
18439
18535
  type: string;
18440
18536
  };
18441
18537
  workspace_id: {
18538
+ description: string;
18442
18539
  format: string;
18443
18540
  type: string;
18444
18541
  };
@@ -18528,21 +18625,37 @@ declare const _default: {
18528
18625
  items: {
18529
18626
  properties: {
18530
18627
  access_schedule: {
18531
- $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;
18532
18641
  };
18533
18642
  acs_system_id: {
18643
+ description: string;
18534
18644
  format: string;
18535
18645
  type: string;
18536
18646
  };
18537
18647
  acs_user_id: {
18648
+ description: string;
18538
18649
  format: string;
18539
18650
  type: string;
18540
18651
  };
18541
18652
  created_at: {
18653
+ description: string;
18542
18654
  format: string;
18543
18655
  type: string;
18544
18656
  };
18545
18657
  display_name: {
18658
+ description: string;
18546
18659
  type: string;
18547
18660
  };
18548
18661
  email: {
@@ -18552,10 +18665,12 @@ declare const _default: {
18552
18665
  'x-deprecated': string;
18553
18666
  };
18554
18667
  email_address: {
18668
+ description: string;
18555
18669
  format: string;
18556
18670
  type: string;
18557
18671
  };
18558
18672
  errors: {
18673
+ description: string;
18559
18674
  items: {
18560
18675
  description: string;
18561
18676
  oneOf: {
@@ -18582,13 +18697,16 @@ declare const _default: {
18582
18697
  type: string;
18583
18698
  };
18584
18699
  external_type: {
18700
+ description: string;
18585
18701
  enum: string[];
18586
18702
  type: string;
18587
18703
  };
18588
18704
  external_type_display_name: {
18705
+ description: string;
18589
18706
  type: string;
18590
18707
  };
18591
18708
  full_name: {
18709
+ description: string;
18592
18710
  type: string;
18593
18711
  };
18594
18712
  hid_acs_system_id: {
@@ -18597,37 +18715,46 @@ declare const _default: {
18597
18715
  };
18598
18716
  is_latest_desired_state_synced_with_provider: {
18599
18717
  type: string;
18718
+ 'x-undocumented': string;
18600
18719
  };
18601
18720
  is_managed: {
18602
18721
  enum: boolean[];
18603
18722
  type: string;
18604
18723
  };
18605
18724
  is_suspended: {
18725
+ description: string;
18606
18726
  type: string;
18607
18727
  };
18608
18728
  latest_desired_state_synced_with_provider_at: {
18609
18729
  format: string;
18610
18730
  type: string;
18731
+ 'x-undocumented': string;
18611
18732
  };
18612
18733
  phone_number: {
18734
+ description: string;
18613
18735
  type: string;
18614
18736
  };
18615
18737
  user_identity_email_address: {
18738
+ description: string;
18616
18739
  nullable: boolean;
18617
18740
  type: string;
18618
18741
  };
18619
18742
  user_identity_full_name: {
18743
+ description: string;
18620
18744
  nullable: boolean;
18621
18745
  type: string;
18622
18746
  };
18623
18747
  user_identity_id: {
18748
+ description: string;
18624
18749
  type: string;
18625
18750
  };
18626
18751
  user_identity_phone_number: {
18752
+ description: string;
18627
18753
  nullable: boolean;
18628
18754
  type: string;
18629
18755
  };
18630
18756
  warnings: {
18757
+ description: string;
18631
18758
  items: {
18632
18759
  description: string;
18633
18760
  oneOf: {
@@ -18652,6 +18779,7 @@ declare const _default: {
18652
18779
  type: string;
18653
18780
  };
18654
18781
  workspace_id: {
18782
+ description: string;
18655
18783
  format: string;
18656
18784
  type: string;
18657
18785
  };
@@ -18702,6 +18830,7 @@ declare const _default: {
18702
18830
  };
18703
18831
  '/acs/users/unsuspend': {
18704
18832
  post: {
18833
+ description: string;
18705
18834
  operationId: string;
18706
18835
  requestBody: {
18707
18836
  content: {
@@ -18709,6 +18838,7 @@ declare const _default: {
18709
18838
  schema: {
18710
18839
  properties: {
18711
18840
  acs_user_id: {
18841
+ description: string;
18712
18842
  format: string;
18713
18843
  type: string;
18714
18844
  };
@@ -18760,10 +18890,12 @@ declare const _default: {
18760
18890
  tags: string[];
18761
18891
  'x-fern-sdk-group-name': string[];
18762
18892
  'x-fern-sdk-method-name': string;
18893
+ 'x-title': string;
18763
18894
  };
18764
18895
  };
18765
18896
  '/acs/users/update': {
18766
18897
  patch: {
18898
+ description: string;
18767
18899
  operationId: string;
18768
18900
  requestBody: {
18769
18901
  content: {
@@ -18771,6 +18903,7 @@ declare const _default: {
18771
18903
  schema: {
18772
18904
  properties: {
18773
18905
  access_schedule: {
18906
+ description: string;
18774
18907
  nullable: boolean;
18775
18908
  properties: {
18776
18909
  ends_at: {
@@ -18786,6 +18919,7 @@ declare const _default: {
18786
18919
  type: string;
18787
18920
  };
18788
18921
  acs_user_id: {
18922
+ description: string;
18789
18923
  format: string;
18790
18924
  type: string;
18791
18925
  };
@@ -18796,10 +18930,12 @@ declare const _default: {
18796
18930
  'x-deprecated': string;
18797
18931
  };
18798
18932
  email_address: {
18933
+ description: string;
18799
18934
  format: string;
18800
18935
  type: string;
18801
18936
  };
18802
18937
  full_name: {
18938
+ description: string;
18803
18939
  type: string;
18804
18940
  };
18805
18941
  hid_acs_system_id: {
@@ -18807,6 +18943,7 @@ declare const _default: {
18807
18943
  type: string;
18808
18944
  };
18809
18945
  phone_number: {
18946
+ description: string;
18810
18947
  type: string;
18811
18948
  };
18812
18949
  };
@@ -18856,8 +18993,10 @@ declare const _default: {
18856
18993
  summary: string;
18857
18994
  tags: string[];
18858
18995
  'x-fern-ignore': boolean;
18996
+ 'x-title': string;
18859
18997
  };
18860
18998
  post: {
18999
+ description: string;
18861
19000
  operationId: string;
18862
19001
  requestBody: {
18863
19002
  content: {
@@ -18865,6 +19004,7 @@ declare const _default: {
18865
19004
  schema: {
18866
19005
  properties: {
18867
19006
  access_schedule: {
19007
+ description: string;
18868
19008
  nullable: boolean;
18869
19009
  properties: {
18870
19010
  ends_at: {
@@ -18880,6 +19020,7 @@ declare const _default: {
18880
19020
  type: string;
18881
19021
  };
18882
19022
  acs_user_id: {
19023
+ description: string;
18883
19024
  format: string;
18884
19025
  type: string;
18885
19026
  };
@@ -18890,10 +19031,12 @@ declare const _default: {
18890
19031
  'x-deprecated': string;
18891
19032
  };
18892
19033
  email_address: {
19034
+ description: string;
18893
19035
  format: string;
18894
19036
  type: string;
18895
19037
  };
18896
19038
  full_name: {
19039
+ description: string;
18897
19040
  type: string;
18898
19041
  };
18899
19042
  hid_acs_system_id: {
@@ -18901,6 +19044,7 @@ declare const _default: {
18901
19044
  type: string;
18902
19045
  };
18903
19046
  phone_number: {
19047
+ description: string;
18904
19048
  type: string;
18905
19049
  };
18906
19050
  };
@@ -18951,6 +19095,7 @@ declare const _default: {
18951
19095
  tags: string[];
18952
19096
  'x-fern-sdk-group-name': string[];
18953
19097
  'x-fern-sdk-method-name': string;
19098
+ 'x-title': string;
18954
19099
  };
18955
19100
  };
18956
19101
  '/action_attempts/get': {
@@ -29536,25 +29681,41 @@ interface Routes {
29536
29681
  formData: {};
29537
29682
  jsonResponse: {
29538
29683
  acs_users: Array<{
29684
+ /** ID of the `acs_user`. */
29539
29685
  acs_user_id: string;
29686
+ /** ID of the access control system that contains the `acs_user`. */
29540
29687
  acs_system_id: string;
29541
29688
  hid_acs_system_id?: string | undefined;
29689
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
29542
29690
  workspace_id: string;
29691
+ /** Date and time at which the `acs_user` was created. */
29543
29692
  created_at: string;
29693
+ /** Display name for the `acs_user`. */
29544
29694
  display_name: string;
29695
+ /** Brand-specific terminology for the `acs_user` type. */
29545
29696
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
29697
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
29546
29698
  external_type_display_name?: string | undefined;
29699
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
29547
29700
  is_suspended: boolean;
29701
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
29548
29702
  access_schedule?: {
29549
29703
  starts_at: string;
29550
29704
  ends_at: string;
29551
29705
  } | undefined;
29706
+ /** ID of the user identity associated with the `acs_user`. */
29552
29707
  user_identity_id?: string | undefined;
29708
+ /** Full name of the user identity associated with the `acs_user`. */
29553
29709
  user_identity_full_name?: (string | null) | undefined;
29710
+ /** Email address of the user identity associated with the `acs_user`. */
29554
29711
  user_identity_email_address?: (string | null) | undefined;
29712
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
29555
29713
  user_identity_phone_number?: (string | null) | undefined;
29714
+ /** */
29556
29715
  latest_desired_state_synced_with_provider_at?: string | undefined;
29716
+ /** */
29557
29717
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
29718
+ /** Warnings associated with the `acs_user`. */
29558
29719
  warnings: Array<{
29559
29720
  created_at: string;
29560
29721
  message: string;
@@ -29564,6 +29725,7 @@ interface Routes {
29564
29725
  message: string;
29565
29726
  warning_code: 'salto_ks_user_not_subscribed';
29566
29727
  }>;
29728
+ /** Errors associated with the `acs_user`. */
29567
29729
  errors: Array<{
29568
29730
  /** Date and time at which Seam created the error. */
29569
29731
  created_at: string;
@@ -29595,11 +29757,14 @@ interface Routes {
29595
29757
  message: string;
29596
29758
  error_code: 'failed_to_delete_on_acs_system';
29597
29759
  }>;
29760
+ /** Full name of the `acs_user`. */
29598
29761
  full_name?: string | undefined;
29599
29762
  /**
29600
29763
  * @deprecated use email_address. */
29601
29764
  email?: string | undefined;
29765
+ /** Email address of the `acs_user`. */
29602
29766
  email_address?: string | undefined;
29767
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
29603
29768
  phone_number?: string | undefined;
29604
29769
  is_managed: true;
29605
29770
  }>;
@@ -30643,7 +30808,9 @@ interface Routes {
30643
30808
  queryParams: {};
30644
30809
  jsonBody: {};
30645
30810
  commonParams: {
30811
+ /** ID of the desired `acs_user`. */
30646
30812
  acs_user_id: string;
30813
+ /** ID of the desired access group. */
30647
30814
  acs_access_group_id: string;
30648
30815
  };
30649
30816
  formData: {};
@@ -30654,43 +30821,66 @@ interface Routes {
30654
30821
  method: 'POST';
30655
30822
  queryParams: {};
30656
30823
  jsonBody: {
30824
+ /** ID of the `acs_system` to which to add the new `acs_user`. */
30657
30825
  acs_system_id: string;
30826
+ /** Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. */
30658
30827
  acs_access_group_ids?: string[];
30828
+ /** ID of the user identity with which to associate the new `acs_user`. */
30659
30829
  user_identity_id?: string | undefined;
30830
+ /** `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. */
30660
30831
  access_schedule?: {
30661
30832
  starts_at: string;
30662
30833
  ends_at: string;
30663
30834
  } | undefined;
30835
+ /** Full name of the `acs_user`. */
30664
30836
  full_name?: string | undefined;
30665
30837
  /**
30666
30838
  * @deprecated use email_address. */
30667
30839
  email?: string | undefined;
30840
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30668
30841
  phone_number?: string | undefined;
30842
+ /** Email address of the `acs_user`. */
30669
30843
  email_address?: string | undefined;
30670
30844
  };
30671
30845
  commonParams: {};
30672
30846
  formData: {};
30673
30847
  jsonResponse: {
30674
30848
  acs_user: {
30849
+ /** ID of the `acs_user`. */
30675
30850
  acs_user_id: string;
30851
+ /** ID of the access control system that contains the `acs_user`. */
30676
30852
  acs_system_id: string;
30677
30853
  hid_acs_system_id?: string | undefined;
30854
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
30678
30855
  workspace_id: string;
30856
+ /** Date and time at which the `acs_user` was created. */
30679
30857
  created_at: string;
30858
+ /** Display name for the `acs_user`. */
30680
30859
  display_name: string;
30860
+ /** Brand-specific terminology for the `acs_user` type. */
30681
30861
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
30862
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
30682
30863
  external_type_display_name?: string | undefined;
30864
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
30683
30865
  is_suspended: boolean;
30866
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
30684
30867
  access_schedule?: {
30685
30868
  starts_at: string;
30686
30869
  ends_at: string;
30687
30870
  } | undefined;
30871
+ /** ID of the user identity associated with the `acs_user`. */
30688
30872
  user_identity_id?: string | undefined;
30873
+ /** Full name of the user identity associated with the `acs_user`. */
30689
30874
  user_identity_full_name?: (string | null) | undefined;
30875
+ /** Email address of the user identity associated with the `acs_user`. */
30690
30876
  user_identity_email_address?: (string | null) | undefined;
30877
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
30691
30878
  user_identity_phone_number?: (string | null) | undefined;
30879
+ /** */
30692
30880
  latest_desired_state_synced_with_provider_at?: string | undefined;
30881
+ /** */
30693
30882
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
30883
+ /** Warnings associated with the `acs_user`. */
30694
30884
  warnings: Array<{
30695
30885
  created_at: string;
30696
30886
  message: string;
@@ -30700,6 +30890,7 @@ interface Routes {
30700
30890
  message: string;
30701
30891
  warning_code: 'salto_ks_user_not_subscribed';
30702
30892
  }>;
30893
+ /** Errors associated with the `acs_user`. */
30703
30894
  errors: Array<{
30704
30895
  /** Date and time at which Seam created the error. */
30705
30896
  created_at: string;
@@ -30731,11 +30922,14 @@ interface Routes {
30731
30922
  message: string;
30732
30923
  error_code: 'failed_to_delete_on_acs_system';
30733
30924
  }>;
30925
+ /** Full name of the `acs_user`. */
30734
30926
  full_name?: string | undefined;
30735
30927
  /**
30736
30928
  * @deprecated use email_address. */
30737
30929
  email?: string | undefined;
30930
+ /** Email address of the `acs_user`. */
30738
30931
  email_address?: string | undefined;
30932
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30739
30933
  phone_number?: string | undefined;
30740
30934
  is_managed: true;
30741
30935
  };
@@ -30747,6 +30941,7 @@ interface Routes {
30747
30941
  queryParams: {};
30748
30942
  jsonBody: {};
30749
30943
  commonParams: {
30944
+ /** ID of the desired `acs_user`. */
30750
30945
  acs_user_id: string;
30751
30946
  };
30752
30947
  formData: {};
@@ -30758,30 +30953,47 @@ interface Routes {
30758
30953
  queryParams: {};
30759
30954
  jsonBody: {};
30760
30955
  commonParams: {
30956
+ /** ID of the desired `acs_user`. */
30761
30957
  acs_user_id: string;
30762
30958
  };
30763
30959
  formData: {};
30764
30960
  jsonResponse: {
30765
30961
  acs_user: {
30962
+ /** ID of the `acs_user`. */
30766
30963
  acs_user_id: string;
30964
+ /** ID of the access control system that contains the `acs_user`. */
30767
30965
  acs_system_id: string;
30768
30966
  hid_acs_system_id?: string | undefined;
30967
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
30769
30968
  workspace_id: string;
30969
+ /** Date and time at which the `acs_user` was created. */
30770
30970
  created_at: string;
30971
+ /** Display name for the `acs_user`. */
30771
30972
  display_name: string;
30973
+ /** Brand-specific terminology for the `acs_user` type. */
30772
30974
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
30975
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
30773
30976
  external_type_display_name?: string | undefined;
30977
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
30774
30978
  is_suspended: boolean;
30979
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
30775
30980
  access_schedule?: {
30776
30981
  starts_at: string;
30777
30982
  ends_at: string;
30778
30983
  } | undefined;
30984
+ /** ID of the user identity associated with the `acs_user`. */
30779
30985
  user_identity_id?: string | undefined;
30986
+ /** Full name of the user identity associated with the `acs_user`. */
30780
30987
  user_identity_full_name?: (string | null) | undefined;
30988
+ /** Email address of the user identity associated with the `acs_user`. */
30781
30989
  user_identity_email_address?: (string | null) | undefined;
30990
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
30782
30991
  user_identity_phone_number?: (string | null) | undefined;
30992
+ /** */
30783
30993
  latest_desired_state_synced_with_provider_at?: string | undefined;
30994
+ /** */
30784
30995
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
30996
+ /** Warnings associated with the `acs_user`. */
30785
30997
  warnings: Array<{
30786
30998
  created_at: string;
30787
30999
  message: string;
@@ -30791,6 +31003,7 @@ interface Routes {
30791
31003
  message: string;
30792
31004
  warning_code: 'salto_ks_user_not_subscribed';
30793
31005
  }>;
31006
+ /** Errors associated with the `acs_user`. */
30794
31007
  errors: Array<{
30795
31008
  /** Date and time at which Seam created the error. */
30796
31009
  created_at: string;
@@ -30822,11 +31035,14 @@ interface Routes {
30822
31035
  message: string;
30823
31036
  error_code: 'failed_to_delete_on_acs_system';
30824
31037
  }>;
31038
+ /** Full name of the `acs_user`. */
30825
31039
  full_name?: string | undefined;
30826
31040
  /**
30827
31041
  * @deprecated use email_address. */
30828
31042
  email?: string | undefined;
31043
+ /** Email address of the `acs_user`. */
30829
31044
  email_address?: string | undefined;
31045
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30830
31046
  phone_number?: string | undefined;
30831
31047
  is_managed: true;
30832
31048
  };
@@ -30838,9 +31054,13 @@ interface Routes {
30838
31054
  queryParams: {};
30839
31055
  jsonBody: {};
30840
31056
  commonParams: {
31057
+ /** ID of the user identity for which you want to retrieve all `acs_user`s. */
30841
31058
  user_identity_id?: string | undefined;
31059
+ /** 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`). */
30842
31060
  user_identity_phone_number?: string | undefined;
31061
+ /** Email address of the user identity for which you want to retrieve all `acs_user`s. */
30843
31062
  user_identity_email_address?: string | undefined;
31063
+ /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
30844
31064
  acs_system_id?: string | undefined;
30845
31065
  limit?: number;
30846
31066
  created_before?: Date | undefined;
@@ -30848,25 +31068,41 @@ interface Routes {
30848
31068
  formData: {};
30849
31069
  jsonResponse: {
30850
31070
  acs_users: Array<{
31071
+ /** ID of the `acs_user`. */
30851
31072
  acs_user_id: string;
31073
+ /** ID of the access control system that contains the `acs_user`. */
30852
31074
  acs_system_id: string;
30853
31075
  hid_acs_system_id?: string | undefined;
31076
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
30854
31077
  workspace_id: string;
31078
+ /** Date and time at which the `acs_user` was created. */
30855
31079
  created_at: string;
31080
+ /** Display name for the `acs_user`. */
30856
31081
  display_name: string;
31082
+ /** Brand-specific terminology for the `acs_user` type. */
30857
31083
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
31084
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
30858
31085
  external_type_display_name?: string | undefined;
31086
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
30859
31087
  is_suspended: boolean;
31088
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
30860
31089
  access_schedule?: {
30861
31090
  starts_at: string;
30862
31091
  ends_at: string;
30863
31092
  } | undefined;
31093
+ /** ID of the user identity associated with the `acs_user`. */
30864
31094
  user_identity_id?: string | undefined;
31095
+ /** Full name of the user identity associated with the `acs_user`. */
30865
31096
  user_identity_full_name?: (string | null) | undefined;
31097
+ /** Email address of the user identity associated with the `acs_user`. */
30866
31098
  user_identity_email_address?: (string | null) | undefined;
31099
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
30867
31100
  user_identity_phone_number?: (string | null) | undefined;
31101
+ /** */
30868
31102
  latest_desired_state_synced_with_provider_at?: string | undefined;
31103
+ /** */
30869
31104
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
31105
+ /** Warnings associated with the `acs_user`. */
30870
31106
  warnings: Array<{
30871
31107
  created_at: string;
30872
31108
  message: string;
@@ -30876,6 +31112,7 @@ interface Routes {
30876
31112
  message: string;
30877
31113
  warning_code: 'salto_ks_user_not_subscribed';
30878
31114
  }>;
31115
+ /** Errors associated with the `acs_user`. */
30879
31116
  errors: Array<{
30880
31117
  /** Date and time at which Seam created the error. */
30881
31118
  created_at: string;
@@ -30907,11 +31144,14 @@ interface Routes {
30907
31144
  message: string;
30908
31145
  error_code: 'failed_to_delete_on_acs_system';
30909
31146
  }>;
31147
+ /** Full name of the `acs_user`. */
30910
31148
  full_name?: string | undefined;
30911
31149
  /**
30912
31150
  * @deprecated use email_address. */
30913
31151
  email?: string | undefined;
31152
+ /** Email address of the `acs_user`. */
30914
31153
  email_address?: string | undefined;
31154
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
30915
31155
  phone_number?: string | undefined;
30916
31156
  is_managed: true;
30917
31157
  }>;
@@ -30923,6 +31163,7 @@ interface Routes {
30923
31163
  queryParams: {};
30924
31164
  jsonBody: {};
30925
31165
  commonParams: {
31166
+ /** ID of the desired `acs_user`. */
30926
31167
  acs_user_id: string;
30927
31168
  };
30928
31169
  formData: {};
@@ -30959,7 +31200,9 @@ interface Routes {
30959
31200
  queryParams: {};
30960
31201
  jsonBody: {};
30961
31202
  commonParams: {
31203
+ /** ID of the desired `acs_user`. */
30962
31204
  acs_user_id: string;
31205
+ /** ID of the desired access group. */
30963
31206
  acs_access_group_id: string;
30964
31207
  };
30965
31208
  formData: {};
@@ -30970,6 +31213,7 @@ interface Routes {
30970
31213
  method: 'POST';
30971
31214
  queryParams: {};
30972
31215
  jsonBody: {
31216
+ /** ID of the desired `acs_user`. */
30973
31217
  acs_user_id: string;
30974
31218
  };
30975
31219
  commonParams: {};
@@ -30982,6 +31226,7 @@ interface Routes {
30982
31226
  queryParams: {};
30983
31227
  jsonBody: {};
30984
31228
  commonParams: {
31229
+ /** ID of the desired `acs_user`. */
30985
31230
  acs_user_id: string;
30986
31231
  };
30987
31232
  formData: {};
@@ -30998,25 +31243,41 @@ interface Routes {
30998
31243
  formData: {};
30999
31244
  jsonResponse: {
31000
31245
  acs_user: {
31246
+ /** ID of the `acs_user`. */
31001
31247
  acs_user_id: string;
31248
+ /** ID of the access control system that contains the `acs_user`. */
31002
31249
  acs_system_id: string;
31003
31250
  hid_acs_system_id?: string | undefined;
31251
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
31004
31252
  workspace_id: string;
31253
+ /** Date and time at which the `acs_user` was created. */
31005
31254
  created_at: string;
31255
+ /** Display name for the `acs_user`. */
31006
31256
  display_name: string;
31257
+ /** Brand-specific terminology for the `acs_user` type. */
31007
31258
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
31259
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
31008
31260
  external_type_display_name?: string | undefined;
31261
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
31009
31262
  is_suspended: boolean;
31263
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
31010
31264
  access_schedule?: {
31011
31265
  starts_at: string;
31012
31266
  ends_at: string;
31013
31267
  } | undefined;
31268
+ /** ID of the user identity associated with the `acs_user`. */
31014
31269
  user_identity_id?: string | undefined;
31270
+ /** Full name of the user identity associated with the `acs_user`. */
31015
31271
  user_identity_full_name?: (string | null) | undefined;
31272
+ /** Email address of the user identity associated with the `acs_user`. */
31016
31273
  user_identity_email_address?: (string | null) | undefined;
31274
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
31017
31275
  user_identity_phone_number?: (string | null) | undefined;
31276
+ /** */
31018
31277
  latest_desired_state_synced_with_provider_at?: string | undefined;
31278
+ /** */
31019
31279
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
31280
+ /** Warnings associated with the `acs_user`. */
31020
31281
  warnings: Array<{
31021
31282
  created_at: string;
31022
31283
  message: string;
@@ -31026,6 +31287,7 @@ interface Routes {
31026
31287
  message: string;
31027
31288
  warning_code: 'salto_ks_user_not_subscribed';
31028
31289
  }>;
31290
+ /** Errors associated with the `acs_user`. */
31029
31291
  errors: Array<{
31030
31292
  /** Date and time at which Seam created the error. */
31031
31293
  created_at: string;
@@ -31057,11 +31319,14 @@ interface Routes {
31057
31319
  message: string;
31058
31320
  error_code: 'failed_to_delete_on_acs_system';
31059
31321
  }>;
31322
+ /** Full name of the `acs_user`. */
31060
31323
  full_name?: string | undefined;
31061
31324
  /**
31062
31325
  * @deprecated use email_address. */
31063
31326
  email?: string | undefined;
31327
+ /** Email address of the `acs_user`. */
31064
31328
  email_address?: string | undefined;
31329
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
31065
31330
  phone_number?: string | undefined;
31066
31331
  is_managed: false;
31067
31332
  };
@@ -31082,25 +31347,41 @@ interface Routes {
31082
31347
  formData: {};
31083
31348
  jsonResponse: {
31084
31349
  acs_users: Array<{
31350
+ /** ID of the `acs_user`. */
31085
31351
  acs_user_id: string;
31352
+ /** ID of the access control system that contains the `acs_user`. */
31086
31353
  acs_system_id: string;
31087
31354
  hid_acs_system_id?: string | undefined;
31355
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
31088
31356
  workspace_id: string;
31357
+ /** Date and time at which the `acs_user` was created. */
31089
31358
  created_at: string;
31359
+ /** Display name for the `acs_user`. */
31090
31360
  display_name: string;
31361
+ /** Brand-specific terminology for the `acs_user` type. */
31091
31362
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
31363
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
31092
31364
  external_type_display_name?: string | undefined;
31365
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
31093
31366
  is_suspended: boolean;
31367
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
31094
31368
  access_schedule?: {
31095
31369
  starts_at: string;
31096
31370
  ends_at: string;
31097
31371
  } | undefined;
31372
+ /** ID of the user identity associated with the `acs_user`. */
31098
31373
  user_identity_id?: string | undefined;
31374
+ /** Full name of the user identity associated with the `acs_user`. */
31099
31375
  user_identity_full_name?: (string | null) | undefined;
31376
+ /** Email address of the user identity associated with the `acs_user`. */
31100
31377
  user_identity_email_address?: (string | null) | undefined;
31378
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
31101
31379
  user_identity_phone_number?: (string | null) | undefined;
31380
+ /** */
31102
31381
  latest_desired_state_synced_with_provider_at?: string | undefined;
31382
+ /** */
31103
31383
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
31384
+ /** Warnings associated with the `acs_user`. */
31104
31385
  warnings: Array<{
31105
31386
  created_at: string;
31106
31387
  message: string;
@@ -31110,6 +31391,7 @@ interface Routes {
31110
31391
  message: string;
31111
31392
  warning_code: 'salto_ks_user_not_subscribed';
31112
31393
  }>;
31394
+ /** Errors associated with the `acs_user`. */
31113
31395
  errors: Array<{
31114
31396
  /** Date and time at which Seam created the error. */
31115
31397
  created_at: string;
@@ -31141,11 +31423,14 @@ interface Routes {
31141
31423
  message: string;
31142
31424
  error_code: 'failed_to_delete_on_acs_system';
31143
31425
  }>;
31426
+ /** Full name of the `acs_user`. */
31144
31427
  full_name?: string | undefined;
31145
31428
  /**
31146
31429
  * @deprecated use email_address. */
31147
31430
  email?: string | undefined;
31431
+ /** Email address of the `acs_user`. */
31148
31432
  email_address?: string | undefined;
31433
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
31149
31434
  phone_number?: string | undefined;
31150
31435
  is_managed: false;
31151
31436
  }>;
@@ -31157,6 +31442,7 @@ interface Routes {
31157
31442
  queryParams: {};
31158
31443
  jsonBody: {};
31159
31444
  commonParams: {
31445
+ /** ID of the desired `acs_user`. */
31160
31446
  acs_user_id: string;
31161
31447
  };
31162
31448
  formData: {};
@@ -31167,16 +31453,21 @@ interface Routes {
31167
31453
  method: 'PATCH' | 'POST';
31168
31454
  queryParams: {};
31169
31455
  jsonBody: {
31456
+ /** `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. */
31170
31457
  access_schedule?: ({
31171
31458
  starts_at: string;
31172
31459
  ends_at: string;
31173
31460
  } | null) | undefined;
31461
+ /** ID of the `acs_user`. */
31174
31462
  acs_user_id: string;
31463
+ /** Full name of the `acs_user`. */
31175
31464
  full_name?: string | undefined;
31176
31465
  /**
31177
31466
  * @deprecated use email_address. */
31178
31467
  email?: string | undefined;
31468
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
31179
31469
  phone_number?: string | undefined;
31470
+ /** Email address of the `acs_user`. */
31180
31471
  email_address?: string | undefined;
31181
31472
  hid_acs_system_id?: string | undefined;
31182
31473
  };
@@ -43292,25 +43583,41 @@ interface Routes {
43292
43583
  formData: {};
43293
43584
  jsonResponse: {
43294
43585
  acs_users: Array<{
43586
+ /** ID of the `acs_user`. */
43295
43587
  acs_user_id: string;
43588
+ /** ID of the access control system that contains the `acs_user`. */
43296
43589
  acs_system_id: string;
43297
43590
  hid_acs_system_id?: string | undefined;
43591
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
43298
43592
  workspace_id: string;
43593
+ /** Date and time at which the `acs_user` was created. */
43299
43594
  created_at: string;
43595
+ /** Display name for the `acs_user`. */
43300
43596
  display_name: string;
43597
+ /** Brand-specific terminology for the `acs_user` type. */
43301
43598
  external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
43599
+ /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
43302
43600
  external_type_display_name?: string | undefined;
43601
+ /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
43303
43602
  is_suspended: boolean;
43603
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
43304
43604
  access_schedule?: {
43305
43605
  starts_at: string;
43306
43606
  ends_at: string;
43307
43607
  } | undefined;
43608
+ /** ID of the user identity associated with the `acs_user`. */
43308
43609
  user_identity_id?: string | undefined;
43610
+ /** Full name of the user identity associated with the `acs_user`. */
43309
43611
  user_identity_full_name?: (string | null) | undefined;
43612
+ /** Email address of the user identity associated with the `acs_user`. */
43310
43613
  user_identity_email_address?: (string | null) | undefined;
43614
+ /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
43311
43615
  user_identity_phone_number?: (string | null) | undefined;
43616
+ /** */
43312
43617
  latest_desired_state_synced_with_provider_at?: string | undefined;
43618
+ /** */
43313
43619
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
43620
+ /** Warnings associated with the `acs_user`. */
43314
43621
  warnings: Array<{
43315
43622
  created_at: string;
43316
43623
  message: string;
@@ -43320,6 +43627,7 @@ interface Routes {
43320
43627
  message: string;
43321
43628
  warning_code: 'salto_ks_user_not_subscribed';
43322
43629
  }>;
43630
+ /** Errors associated with the `acs_user`. */
43323
43631
  errors: Array<{
43324
43632
  /** Date and time at which Seam created the error. */
43325
43633
  created_at: string;
@@ -43351,11 +43659,14 @@ interface Routes {
43351
43659
  message: string;
43352
43660
  error_code: 'failed_to_delete_on_acs_system';
43353
43661
  }>;
43662
+ /** Full name of the `acs_user`. */
43354
43663
  full_name?: string | undefined;
43355
43664
  /**
43356
43665
  * @deprecated use email_address. */
43357
43666
  email?: string | undefined;
43667
+ /** Email address of the `acs_user`. */
43358
43668
  email_address?: string | undefined;
43669
+ /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
43359
43670
  phone_number?: string | undefined;
43360
43671
  is_managed: true;
43361
43672
  }>;