@seamapi/types 1.293.1 → 1.294.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.
Files changed (17) hide show
  1. package/dist/connect.cjs +282 -68
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +148 -2
  4. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.d.ts +3 -5
  5. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +23 -6
  6. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
  7. package/lib/seam/connect/models/user-identities/user-identity.js +26 -8
  8. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  9. package/lib/seam/connect/openapi.d.ts +86 -0
  10. package/lib/seam/connect/openapi.js +249 -41
  11. package/lib/seam/connect/openapi.js.map +1 -1
  12. package/lib/seam/connect/route-types.d.ts +62 -2
  13. package/package.json +1 -1
  14. package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +32 -7
  15. package/src/lib/seam/connect/models/user-identities/user-identity.ts +34 -10
  16. package/src/lib/seam/connect/openapi.ts +287 -41
  17. package/src/lib/seam/connect/route-types.ts +62 -2
package/dist/connect.d.cts CHANGED
@@ -15586,24 +15586,30 @@ declare const _default: {
15586
15586
  type: string;
15587
15587
  };
15588
15588
  enrollment_automation: {
15589
+ description: string;
15589
15590
  properties: {
15590
15591
  created_at: {
15592
+ description: string;
15591
15593
  format: string;
15592
15594
  type: string;
15593
15595
  };
15594
15596
  credential_manager_acs_system_id: {
15597
+ description: string;
15595
15598
  format: string;
15596
15599
  type: string;
15597
15600
  };
15598
15601
  enrollment_automation_id: {
15602
+ description: string;
15599
15603
  format: string;
15600
15604
  type: string;
15601
15605
  };
15602
15606
  user_identity_id: {
15607
+ description: string;
15603
15608
  format: string;
15604
15609
  type: string;
15605
15610
  };
15606
15611
  workspace_id: {
15612
+ description: string;
15607
15613
  format: string;
15608
15614
  type: string;
15609
15615
  };
@@ -16409,8 +16415,10 @@ declare const _default: {
16409
16415
  type: string;
16410
16416
  };
16411
16417
  user_identity: {
16418
+ description: string;
16412
16419
  properties: {
16413
16420
  created_at: {
16421
+ description: string;
16414
16422
  format: string;
16415
16423
  type: string;
16416
16424
  };
@@ -16419,6 +16427,7 @@ declare const _default: {
16419
16427
  type: string;
16420
16428
  };
16421
16429
  email_address: {
16430
+ description: string;
16422
16431
  format: string;
16423
16432
  nullable: boolean;
16424
16433
  type: string;
@@ -16429,19 +16438,23 @@ declare const _default: {
16429
16438
  type: string;
16430
16439
  };
16431
16440
  phone_number: {
16441
+ description: string;
16432
16442
  nullable: boolean;
16433
16443
  type: string;
16434
16444
  };
16435
16445
  user_identity_id: {
16446
+ description: string;
16436
16447
  format: string;
16437
16448
  type: string;
16438
16449
  };
16439
16450
  user_identity_key: {
16451
+ description: string;
16440
16452
  minLength: number;
16441
16453
  nullable: boolean;
16442
16454
  type: string;
16443
16455
  };
16444
16456
  workspace_id: {
16457
+ description: string;
16445
16458
  format: string;
16446
16459
  type: string;
16447
16460
  };
@@ -18495,6 +18508,7 @@ declare const _default: {
18495
18508
  summary: string;
18496
18509
  tags: string[];
18497
18510
  'x-fern-ignore': boolean;
18511
+ 'x-response-key': null;
18498
18512
  };
18499
18513
  post: {
18500
18514
  operationId: string;
@@ -18571,6 +18585,7 @@ declare const _default: {
18571
18585
  tags: string[];
18572
18586
  'x-fern-sdk-group-name': string[];
18573
18587
  'x-fern-sdk-method-name': string;
18588
+ 'x-response-key': null;
18574
18589
  };
18575
18590
  };
18576
18591
  '/acs/access_groups/add_user': {
@@ -29878,6 +29893,7 @@ declare const _default: {
29878
29893
  };
29879
29894
  '/user_identities/add_acs_user': {
29880
29895
  post: {
29896
+ description: string;
29881
29897
  operationId: string;
29882
29898
  requestBody: {
29883
29899
  content: {
@@ -29885,10 +29901,12 @@ declare const _default: {
29885
29901
  schema: {
29886
29902
  properties: {
29887
29903
  acs_user_id: {
29904
+ description: string;
29888
29905
  format: string;
29889
29906
  type: string;
29890
29907
  };
29891
29908
  user_identity_id: {
29909
+ description: string;
29892
29910
  format: string;
29893
29911
  type: string;
29894
29912
  };
@@ -29941,8 +29959,10 @@ declare const _default: {
29941
29959
  'x-fern-sdk-group-name': string[];
29942
29960
  'x-fern-sdk-method-name': string;
29943
29961
  'x-response-key': null;
29962
+ 'x-title': string;
29944
29963
  };
29945
29964
  put: {
29965
+ description: string;
29946
29966
  operationId: string;
29947
29967
  requestBody: {
29948
29968
  content: {
@@ -29950,10 +29970,12 @@ declare const _default: {
29950
29970
  schema: {
29951
29971
  properties: {
29952
29972
  acs_user_id: {
29973
+ description: string;
29953
29974
  format: string;
29954
29975
  type: string;
29955
29976
  };
29956
29977
  user_identity_id: {
29978
+ description: string;
29957
29979
  format: string;
29958
29980
  type: string;
29959
29981
  };
@@ -30005,10 +30027,12 @@ declare const _default: {
30005
30027
  tags: string[];
30006
30028
  'x-fern-ignore': boolean;
30007
30029
  'x-response-key': null;
30030
+ 'x-title': string;
30008
30031
  };
30009
30032
  };
30010
30033
  '/user_identities/create': {
30011
30034
  post: {
30035
+ description: string;
30012
30036
  operationId: string;
30013
30037
  requestBody: {
30014
30038
  content: {
@@ -30016,20 +30040,24 @@ declare const _default: {
30016
30040
  schema: {
30017
30041
  properties: {
30018
30042
  email_address: {
30043
+ description: string;
30019
30044
  format: string;
30020
30045
  nullable: boolean;
30021
30046
  type: string;
30022
30047
  };
30023
30048
  full_name: {
30049
+ description: string;
30024
30050
  minLength: number;
30025
30051
  nullable: boolean;
30026
30052
  type: string;
30027
30053
  };
30028
30054
  phone_number: {
30055
+ description: string;
30029
30056
  nullable: boolean;
30030
30057
  type: string;
30031
30058
  };
30032
30059
  user_identity_key: {
30060
+ description: string;
30033
30061
  minLength: number;
30034
30062
  nullable: boolean;
30035
30063
  type: string;
@@ -30086,10 +30114,12 @@ declare const _default: {
30086
30114
  'x-fern-sdk-method-name': string;
30087
30115
  'x-fern-sdk-return-value': string;
30088
30116
  'x-response-key': string;
30117
+ 'x-title': string;
30089
30118
  };
30090
30119
  };
30091
30120
  '/user_identities/delete': {
30092
30121
  post: {
30122
+ description: string;
30093
30123
  operationId: string;
30094
30124
  requestBody: {
30095
30125
  content: {
@@ -30097,6 +30127,7 @@ declare const _default: {
30097
30127
  schema: {
30098
30128
  properties: {
30099
30129
  user_identity_id: {
30130
+ description: string;
30100
30131
  format: string;
30101
30132
  type: string;
30102
30133
  };
@@ -30149,10 +30180,12 @@ declare const _default: {
30149
30180
  'x-fern-sdk-group-name': string[];
30150
30181
  'x-fern-sdk-method-name': string;
30151
30182
  'x-response-key': null;
30183
+ 'x-title': string;
30152
30184
  };
30153
30185
  };
30154
30186
  '/user_identities/enrollment_automations/delete': {
30155
30187
  post: {
30188
+ description: string;
30156
30189
  operationId: string;
30157
30190
  requestBody: {
30158
30191
  content: {
@@ -30160,6 +30193,7 @@ declare const _default: {
30160
30193
  schema: {
30161
30194
  properties: {
30162
30195
  enrollment_automation_id: {
30196
+ description: string;
30163
30197
  format: string;
30164
30198
  type: string;
30165
30199
  };
@@ -30212,10 +30246,12 @@ declare const _default: {
30212
30246
  'x-fern-sdk-group-name': string[];
30213
30247
  'x-fern-sdk-method-name': string;
30214
30248
  'x-response-key': null;
30249
+ 'x-title': string;
30215
30250
  };
30216
30251
  };
30217
30252
  '/user_identities/enrollment_automations/get': {
30218
30253
  post: {
30254
+ description: string;
30219
30255
  operationId: string;
30220
30256
  requestBody: {
30221
30257
  content: {
@@ -30223,6 +30259,7 @@ declare const _default: {
30223
30259
  schema: {
30224
30260
  properties: {
30225
30261
  enrollment_automation_id: {
30262
+ description: string;
30226
30263
  format: string;
30227
30264
  type: string;
30228
30265
  };
@@ -30287,10 +30324,12 @@ declare const _default: {
30287
30324
  'x-fern-sdk-method-name': string;
30288
30325
  'x-fern-sdk-return-value': string;
30289
30326
  'x-response-key': string;
30327
+ 'x-title': string;
30290
30328
  };
30291
30329
  };
30292
30330
  '/user_identities/enrollment_automations/launch': {
30293
30331
  post: {
30332
+ description: string;
30294
30333
  operationId: string;
30295
30334
  requestBody: {
30296
30335
  content: {
@@ -30298,21 +30337,26 @@ declare const _default: {
30298
30337
  schema: {
30299
30338
  properties: {
30300
30339
  acs_credential_pool_id: {
30340
+ description: string;
30301
30341
  format: string;
30302
30342
  type: string;
30303
30343
  };
30304
30344
  create_credential_manager_user: {
30345
+ description: string;
30305
30346
  type: string;
30306
30347
  };
30307
30348
  credential_manager_acs_system_id: {
30349
+ description: string;
30308
30350
  format: string;
30309
30351
  type: string;
30310
30352
  };
30311
30353
  credential_manager_acs_user_id: {
30354
+ description: string;
30312
30355
  format: string;
30313
30356
  type: string;
30314
30357
  };
30315
30358
  user_identity_id: {
30359
+ description: string;
30316
30360
  format: string;
30317
30361
  type: string;
30318
30362
  };
@@ -30396,10 +30440,12 @@ declare const _default: {
30396
30440
  'x-fern-sdk-method-name': string;
30397
30441
  'x-fern-sdk-return-value': string;
30398
30442
  'x-response-key': string;
30443
+ 'x-title': string;
30399
30444
  };
30400
30445
  };
30401
30446
  '/user_identities/enrollment_automations/list': {
30402
30447
  post: {
30448
+ description: string;
30403
30449
  operationId: string;
30404
30450
  requestBody: {
30405
30451
  content: {
@@ -30407,6 +30453,7 @@ declare const _default: {
30407
30453
  schema: {
30408
30454
  properties: {
30409
30455
  user_identity_id: {
30456
+ description: string;
30410
30457
  format: string;
30411
30458
  type: string;
30412
30459
  };
@@ -30474,10 +30521,12 @@ declare const _default: {
30474
30521
  'x-fern-sdk-method-name': string;
30475
30522
  'x-fern-sdk-return-value': string;
30476
30523
  'x-response-key': string;
30524
+ 'x-title': string;
30477
30525
  };
30478
30526
  };
30479
30527
  '/user_identities/get': {
30480
30528
  post: {
30529
+ description: string;
30481
30530
  operationId: string;
30482
30531
  requestBody: {
30483
30532
  content: {
@@ -30486,6 +30535,7 @@ declare const _default: {
30486
30535
  oneOf: ({
30487
30536
  properties: {
30488
30537
  user_identity_id: {
30538
+ description: string;
30489
30539
  format: string;
30490
30540
  type: string;
30491
30541
  };
@@ -30553,10 +30603,12 @@ declare const _default: {
30553
30603
  'x-fern-sdk-method-name': string;
30554
30604
  'x-fern-sdk-return-value': string;
30555
30605
  'x-response-key': string;
30606
+ 'x-title': string;
30556
30607
  };
30557
30608
  };
30558
30609
  '/user_identities/grant_access_to_device': {
30559
30610
  post: {
30611
+ description: string;
30560
30612
  operationId: string;
30561
30613
  requestBody: {
30562
30614
  content: {
@@ -30564,10 +30616,12 @@ declare const _default: {
30564
30616
  schema: {
30565
30617
  properties: {
30566
30618
  device_id: {
30619
+ description: string;
30567
30620
  format: string;
30568
30621
  type: string;
30569
30622
  };
30570
30623
  user_identity_id: {
30624
+ description: string;
30571
30625
  format: string;
30572
30626
  type: string;
30573
30627
  };
@@ -30620,8 +30674,10 @@ declare const _default: {
30620
30674
  'x-fern-sdk-group-name': string[];
30621
30675
  'x-fern-sdk-method-name': string;
30622
30676
  'x-response-key': null;
30677
+ 'x-title': string;
30623
30678
  };
30624
30679
  put: {
30680
+ description: string;
30625
30681
  operationId: string;
30626
30682
  requestBody: {
30627
30683
  content: {
@@ -30629,10 +30685,12 @@ declare const _default: {
30629
30685
  schema: {
30630
30686
  properties: {
30631
30687
  device_id: {
30688
+ description: string;
30632
30689
  format: string;
30633
30690
  type: string;
30634
30691
  };
30635
30692
  user_identity_id: {
30693
+ description: string;
30636
30694
  format: string;
30637
30695
  type: string;
30638
30696
  };
@@ -30684,10 +30742,12 @@ declare const _default: {
30684
30742
  tags: string[];
30685
30743
  'x-fern-ignore': boolean;
30686
30744
  'x-response-key': null;
30745
+ 'x-title': string;
30687
30746
  };
30688
30747
  };
30689
30748
  '/user_identities/list': {
30690
30749
  post: {
30750
+ description: string;
30691
30751
  operationId: string;
30692
30752
  requestBody: {
30693
30753
  content: {
@@ -30761,10 +30821,12 @@ declare const _default: {
30761
30821
  'x-fern-sdk-method-name': string;
30762
30822
  'x-fern-sdk-return-value': string;
30763
30823
  'x-response-key': string;
30824
+ 'x-title': string;
30764
30825
  };
30765
30826
  };
30766
30827
  '/user_identities/list_accessible_devices': {
30767
30828
  post: {
30829
+ description: string;
30768
30830
  operationId: string;
30769
30831
  requestBody: {
30770
30832
  content: {
@@ -30772,6 +30834,7 @@ declare const _default: {
30772
30834
  schema: {
30773
30835
  properties: {
30774
30836
  user_identity_id: {
30837
+ description: string;
30775
30838
  format: string;
30776
30839
  type: string;
30777
30840
  };
@@ -30839,10 +30902,12 @@ declare const _default: {
30839
30902
  'x-fern-sdk-method-name': string;
30840
30903
  'x-fern-sdk-return-value': string;
30841
30904
  'x-response-key': string;
30905
+ 'x-title': string;
30842
30906
  };
30843
30907
  };
30844
30908
  '/user_identities/list_acs_systems': {
30845
30909
  post: {
30910
+ description: string;
30846
30911
  operationId: string;
30847
30912
  requestBody: {
30848
30913
  content: {
@@ -30850,6 +30915,7 @@ declare const _default: {
30850
30915
  schema: {
30851
30916
  properties: {
30852
30917
  user_identity_id: {
30918
+ description: string;
30853
30919
  format: string;
30854
30920
  type: string;
30855
30921
  };
@@ -30917,10 +30983,12 @@ declare const _default: {
30917
30983
  'x-fern-sdk-method-name': string;
30918
30984
  'x-fern-sdk-return-value': string;
30919
30985
  'x-response-key': string;
30986
+ 'x-title': string;
30920
30987
  };
30921
30988
  };
30922
30989
  '/user_identities/list_acs_users': {
30923
30990
  post: {
30991
+ description: string;
30924
30992
  operationId: string;
30925
30993
  requestBody: {
30926
30994
  content: {
@@ -30928,6 +30996,7 @@ declare const _default: {
30928
30996
  schema: {
30929
30997
  properties: {
30930
30998
  user_identity_id: {
30999
+ description: string;
30931
31000
  format: string;
30932
31001
  type: string;
30933
31002
  };
@@ -30987,10 +31056,12 @@ declare const _default: {
30987
31056
  'x-fern-sdk-method-name': string;
30988
31057
  'x-fern-sdk-return-value': string;
30989
31058
  'x-response-key': string;
31059
+ 'x-title': string;
30990
31060
  };
30991
31061
  };
30992
31062
  '/user_identities/remove_acs_user': {
30993
31063
  post: {
31064
+ description: string;
30994
31065
  operationId: string;
30995
31066
  requestBody: {
30996
31067
  content: {
@@ -30998,10 +31069,12 @@ declare const _default: {
30998
31069
  schema: {
30999
31070
  properties: {
31000
31071
  acs_user_id: {
31072
+ description: string;
31001
31073
  format: string;
31002
31074
  type: string;
31003
31075
  };
31004
31076
  user_identity_id: {
31077
+ description: string;
31005
31078
  format: string;
31006
31079
  type: string;
31007
31080
  };
@@ -31054,10 +31127,12 @@ declare const _default: {
31054
31127
  'x-fern-sdk-group-name': string[];
31055
31128
  'x-fern-sdk-method-name': string;
31056
31129
  'x-response-key': null;
31130
+ 'x-title': string;
31057
31131
  };
31058
31132
  };
31059
31133
  '/user_identities/revoke_access_to_device': {
31060
31134
  post: {
31135
+ description: string;
31061
31136
  operationId: string;
31062
31137
  requestBody: {
31063
31138
  content: {
@@ -31065,10 +31140,12 @@ declare const _default: {
31065
31140
  schema: {
31066
31141
  properties: {
31067
31142
  device_id: {
31143
+ description: string;
31068
31144
  format: string;
31069
31145
  type: string;
31070
31146
  };
31071
31147
  user_identity_id: {
31148
+ description: string;
31072
31149
  format: string;
31073
31150
  type: string;
31074
31151
  };
@@ -31121,6 +31198,7 @@ declare const _default: {
31121
31198
  'x-fern-sdk-group-name': string[];
31122
31199
  'x-fern-sdk-method-name': string;
31123
31200
  'x-response-key': null;
31201
+ 'x-title': string;
31124
31202
  };
31125
31203
  };
31126
31204
  '/user_identities/update': {
@@ -31132,6 +31210,7 @@ declare const _default: {
31132
31210
  schema: {
31133
31211
  properties: {
31134
31212
  email_address: {
31213
+ description: string;
31135
31214
  format: string;
31136
31215
  nullable: boolean;
31137
31216
  type: string;
@@ -31142,14 +31221,17 @@ declare const _default: {
31142
31221
  type: string;
31143
31222
  };
31144
31223
  phone_number: {
31224
+ description: string;
31145
31225
  nullable: boolean;
31146
31226
  type: string;
31147
31227
  };
31148
31228
  user_identity_id: {
31229
+ description: string;
31149
31230
  format: string;
31150
31231
  type: string;
31151
31232
  };
31152
31233
  user_identity_key: {
31234
+ description: string;
31153
31235
  minLength: number;
31154
31236
  nullable: boolean;
31155
31237
  type: string;
@@ -31211,6 +31293,7 @@ declare const _default: {
31211
31293
  schema: {
31212
31294
  properties: {
31213
31295
  email_address: {
31296
+ description: string;
31214
31297
  format: string;
31215
31298
  nullable: boolean;
31216
31299
  type: string;
@@ -31221,14 +31304,17 @@ declare const _default: {
31221
31304
  type: string;
31222
31305
  };
31223
31306
  phone_number: {
31307
+ description: string;
31224
31308
  nullable: boolean;
31225
31309
  type: string;
31226
31310
  };
31227
31311
  user_identity_id: {
31312
+ description: string;
31228
31313
  format: string;
31229
31314
  type: string;
31230
31315
  };
31231
31316
  user_identity_key: {
31317
+ description: string;
31232
31318
  minLength: number;
31233
31319
  nullable: boolean;
31234
31320
  type: string;
@@ -56355,7 +56441,9 @@ interface Routes {
56355
56441
  queryParams: {};
56356
56442
  jsonBody: {};
56357
56443
  commonParams: {
56444
+ /** ID of the desired user identity. */
56358
56445
  user_identity_id: string;
56446
+ /** ID of the desired ACS user. */
56359
56447
  acs_user_id: string;
56360
56448
  };
56361
56449
  formData: {};
@@ -56367,21 +56455,32 @@ interface Routes {
56367
56455
  queryParams: {};
56368
56456
  jsonBody: {};
56369
56457
  commonParams: {
56458
+ /** Unique key for the user identity. */
56370
56459
  user_identity_key?: (string | null) | undefined;
56460
+ /** Unique email address for the user identity. */
56371
56461
  email_address?: (string | null) | undefined;
56462
+ /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
56372
56463
  phone_number?: (string | null) | undefined;
56464
+ /** Full name of the user associated with the user identity. */
56373
56465
  full_name?: (string | null) | undefined;
56374
56466
  };
56375
56467
  formData: {};
56376
56468
  jsonResponse: {
56469
+ /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
56377
56470
  user_identity: {
56471
+ /** ID of the user identity. */
56378
56472
  user_identity_id: string;
56473
+ /** Unique key for the user identity. */
56379
56474
  user_identity_key: string | null;
56475
+ /** Unique email address for the user identity. */
56380
56476
  email_address: string | null;
56477
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
56381
56478
  phone_number: string | null;
56382
56479
  display_name: string;
56383
56480
  full_name: string | null;
56481
+ /** Date and time at which the user identity was created. */
56384
56482
  created_at: string;
56483
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
56385
56484
  workspace_id: string;
56386
56485
  };
56387
56486
  };
@@ -56392,6 +56491,7 @@ interface Routes {
56392
56491
  queryParams: {};
56393
56492
  jsonBody: {};
56394
56493
  commonParams: {
56494
+ /** ID of the desired user identity. */
56395
56495
  user_identity_id: string;
56396
56496
  };
56397
56497
  formData: {};
@@ -56403,6 +56503,7 @@ interface Routes {
56403
56503
  queryParams: {};
56404
56504
  jsonBody: {};
56405
56505
  commonParams: {
56506
+ /** ID of the desired enrollment automation. */
56406
56507
  enrollment_automation_id: string;
56407
56508
  };
56408
56509
  formData: {};
@@ -56414,16 +56515,23 @@ interface Routes {
56414
56515
  queryParams: {};
56415
56516
  jsonBody: {};
56416
56517
  commonParams: {
56518
+ /** ID of the desired enrollment automation. */
56417
56519
  enrollment_automation_id: string;
56418
56520
  };
56419
56521
  formData: {};
56420
56522
  jsonResponse: {
56523
+ /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). */
56421
56524
  enrollment_automation: {
56525
+ /** ID of the enrollment automation. */
56526
+ enrollment_automation_id: string;
56527
+ /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
56422
56528
  credential_manager_acs_system_id: string;
56529
+ /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
56423
56530
  user_identity_id: string;
56531
+ /** Date and time at which the enrollment automation was created. */
56424
56532
  created_at: string;
56533
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
56425
56534
  workspace_id: string;
56426
- enrollment_automation_id: string;
56427
56535
  };
56428
56536
  };
56429
56537
  };
@@ -56433,10 +56541,15 @@ interface Routes {
56433
56541
  queryParams: {};
56434
56542
  jsonBody: {};
56435
56543
  commonParams: {
56544
+ /** ID of the desired user identity. */
56436
56545
  user_identity_id: string;
56546
+ /** ID of the desired ACS system that serves as the credential manager. */
56437
56547
  credential_manager_acs_system_id: string;
56548
+ /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
56438
56549
  acs_credential_pool_id?: string | undefined;
56550
+ /** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
56439
56551
  create_credential_manager_user?: boolean | undefined;
56552
+ /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
56440
56553
  credential_manager_acs_user_id?: string | undefined;
56441
56554
  };
56442
56555
  formData: {};
@@ -56457,16 +56570,22 @@ interface Routes {
56457
56570
  queryParams: {};
56458
56571
  jsonBody: {};
56459
56572
  commonParams: {
56573
+ /** ID of the user identity for which you want to retrieve all enrollment automations. */
56460
56574
  user_identity_id: string;
56461
56575
  };
56462
56576
  formData: {};
56463
56577
  jsonResponse: {
56464
56578
  enrollment_automations: Array<{
56579
+ /** ID of the enrollment automation. */
56580
+ enrollment_automation_id: string;
56581
+ /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
56465
56582
  credential_manager_acs_system_id: string;
56583
+ /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
56466
56584
  user_identity_id: string;
56585
+ /** Date and time at which the enrollment automation was created. */
56467
56586
  created_at: string;
56587
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
56468
56588
  workspace_id: string;
56469
- enrollment_automation_id: string;
56470
56589
  }>;
56471
56590
  };
56472
56591
  };
@@ -56476,20 +56595,28 @@ interface Routes {
56476
56595
  queryParams: {};
56477
56596
  jsonBody: {};
56478
56597
  commonParams: {
56598
+ /** ID of the desired user identity. */
56479
56599
  user_identity_id: string;
56480
56600
  } | {
56481
56601
  user_identity_key: string;
56482
56602
  };
56483
56603
  formData: {};
56484
56604
  jsonResponse: {
56605
+ /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
56485
56606
  user_identity: {
56607
+ /** ID of the user identity. */
56486
56608
  user_identity_id: string;
56609
+ /** Unique key for the user identity. */
56487
56610
  user_identity_key: string | null;
56611
+ /** Unique email address for the user identity. */
56488
56612
  email_address: string | null;
56613
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
56489
56614
  phone_number: string | null;
56490
56615
  display_name: string;
56491
56616
  full_name: string | null;
56617
+ /** Date and time at which the user identity was created. */
56492
56618
  created_at: string;
56619
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
56493
56620
  workspace_id: string;
56494
56621
  };
56495
56622
  };
@@ -56500,7 +56627,9 @@ interface Routes {
56500
56627
  queryParams: {};
56501
56628
  jsonBody: {};
56502
56629
  commonParams: {
56630
+ /** ID of the desired user identity. */
56503
56631
  user_identity_id: string;
56632
+ /** ID of the desired managed device. */
56504
56633
  device_id: string;
56505
56634
  };
56506
56635
  formData: {};
@@ -56517,13 +56646,19 @@ interface Routes {
56517
56646
  formData: {};
56518
56647
  jsonResponse: {
56519
56648
  user_identities: Array<{
56649
+ /** ID of the user identity. */
56520
56650
  user_identity_id: string;
56651
+ /** Unique key for the user identity. */
56521
56652
  user_identity_key: string | null;
56653
+ /** Unique email address for the user identity. */
56522
56654
  email_address: string | null;
56655
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
56523
56656
  phone_number: string | null;
56524
56657
  display_name: string;
56525
56658
  full_name: string | null;
56659
+ /** Date and time at which the user identity was created. */
56526
56660
  created_at: string;
56661
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
56527
56662
  workspace_id: string;
56528
56663
  }>;
56529
56664
  };
@@ -56534,6 +56669,7 @@ interface Routes {
56534
56669
  queryParams: {};
56535
56670
  jsonBody: {};
56536
56671
  commonParams: {
56672
+ /** ID of the user identity for which you want to retrieve all accessible devices. */
56537
56673
  user_identity_id: string;
56538
56674
  };
56539
56675
  formData: {};
@@ -57574,6 +57710,7 @@ interface Routes {
57574
57710
  queryParams: {};
57575
57711
  jsonBody: {};
57576
57712
  commonParams: {
57713
+ /** ID of the user identity for which you want to retrieve all access control systems. */
57577
57714
  user_identity_id: string;
57578
57715
  };
57579
57716
  formData: {};
@@ -57682,6 +57819,7 @@ interface Routes {
57682
57819
  queryParams: {};
57683
57820
  jsonBody: {};
57684
57821
  commonParams: {
57822
+ /** ID of the user identity for which you want to retrieve all ACS users. */
57685
57823
  user_identity_id: string;
57686
57824
  };
57687
57825
  formData: {};
@@ -57784,7 +57922,9 @@ interface Routes {
57784
57922
  queryParams: {};
57785
57923
  jsonBody: {};
57786
57924
  commonParams: {
57925
+ /** ID of the desired user identity. */
57787
57926
  user_identity_id: string;
57927
+ /** ID of the ACS user. */
57788
57928
  acs_user_id: string;
57789
57929
  };
57790
57930
  formData: {};
@@ -57796,7 +57936,9 @@ interface Routes {
57796
57936
  queryParams: {};
57797
57937
  jsonBody: {};
57798
57938
  commonParams: {
57939
+ /** ID of the desired user identity. */
57799
57940
  user_identity_id: string;
57941
+ /** ID of the desired managed device. */
57800
57942
  device_id: string;
57801
57943
  };
57802
57944
  formData: {};
@@ -57807,9 +57949,13 @@ interface Routes {
57807
57949
  method: 'PATCH' | 'POST';
57808
57950
  queryParams: {};
57809
57951
  jsonBody: {
57952
+ /** ID of the user identity. */
57810
57953
  user_identity_id: string;
57954
+ /** Unique key for the user identity. */
57811
57955
  user_identity_key?: (string | null) | undefined;
57956
+ /** Unique email address for the user identity. */
57812
57957
  email_address?: (string | null) | undefined;
57958
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
57813
57959
  phone_number?: (string | null) | undefined;
57814
57960
  full_name?: (string | null) | undefined;
57815
57961
  };