@seamapi/types 1.293.1 → 1.294.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 (17) hide show
  1. package/dist/connect.cjs +278 -66
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +146 -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 +84 -0
  10. package/lib/seam/connect/openapi.js +247 -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 +285 -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
  };
@@ -29878,6 +29891,7 @@ declare const _default: {
29878
29891
  };
29879
29892
  '/user_identities/add_acs_user': {
29880
29893
  post: {
29894
+ description: string;
29881
29895
  operationId: string;
29882
29896
  requestBody: {
29883
29897
  content: {
@@ -29885,10 +29899,12 @@ declare const _default: {
29885
29899
  schema: {
29886
29900
  properties: {
29887
29901
  acs_user_id: {
29902
+ description: string;
29888
29903
  format: string;
29889
29904
  type: string;
29890
29905
  };
29891
29906
  user_identity_id: {
29907
+ description: string;
29892
29908
  format: string;
29893
29909
  type: string;
29894
29910
  };
@@ -29941,8 +29957,10 @@ declare const _default: {
29941
29957
  'x-fern-sdk-group-name': string[];
29942
29958
  'x-fern-sdk-method-name': string;
29943
29959
  'x-response-key': null;
29960
+ 'x-title': string;
29944
29961
  };
29945
29962
  put: {
29963
+ description: string;
29946
29964
  operationId: string;
29947
29965
  requestBody: {
29948
29966
  content: {
@@ -29950,10 +29968,12 @@ declare const _default: {
29950
29968
  schema: {
29951
29969
  properties: {
29952
29970
  acs_user_id: {
29971
+ description: string;
29953
29972
  format: string;
29954
29973
  type: string;
29955
29974
  };
29956
29975
  user_identity_id: {
29976
+ description: string;
29957
29977
  format: string;
29958
29978
  type: string;
29959
29979
  };
@@ -30005,10 +30025,12 @@ declare const _default: {
30005
30025
  tags: string[];
30006
30026
  'x-fern-ignore': boolean;
30007
30027
  'x-response-key': null;
30028
+ 'x-title': string;
30008
30029
  };
30009
30030
  };
30010
30031
  '/user_identities/create': {
30011
30032
  post: {
30033
+ description: string;
30012
30034
  operationId: string;
30013
30035
  requestBody: {
30014
30036
  content: {
@@ -30016,20 +30038,24 @@ declare const _default: {
30016
30038
  schema: {
30017
30039
  properties: {
30018
30040
  email_address: {
30041
+ description: string;
30019
30042
  format: string;
30020
30043
  nullable: boolean;
30021
30044
  type: string;
30022
30045
  };
30023
30046
  full_name: {
30047
+ description: string;
30024
30048
  minLength: number;
30025
30049
  nullable: boolean;
30026
30050
  type: string;
30027
30051
  };
30028
30052
  phone_number: {
30053
+ description: string;
30029
30054
  nullable: boolean;
30030
30055
  type: string;
30031
30056
  };
30032
30057
  user_identity_key: {
30058
+ description: string;
30033
30059
  minLength: number;
30034
30060
  nullable: boolean;
30035
30061
  type: string;
@@ -30086,10 +30112,12 @@ declare const _default: {
30086
30112
  'x-fern-sdk-method-name': string;
30087
30113
  'x-fern-sdk-return-value': string;
30088
30114
  'x-response-key': string;
30115
+ 'x-title': string;
30089
30116
  };
30090
30117
  };
30091
30118
  '/user_identities/delete': {
30092
30119
  post: {
30120
+ description: string;
30093
30121
  operationId: string;
30094
30122
  requestBody: {
30095
30123
  content: {
@@ -30097,6 +30125,7 @@ declare const _default: {
30097
30125
  schema: {
30098
30126
  properties: {
30099
30127
  user_identity_id: {
30128
+ description: string;
30100
30129
  format: string;
30101
30130
  type: string;
30102
30131
  };
@@ -30149,10 +30178,12 @@ declare const _default: {
30149
30178
  'x-fern-sdk-group-name': string[];
30150
30179
  'x-fern-sdk-method-name': string;
30151
30180
  'x-response-key': null;
30181
+ 'x-title': string;
30152
30182
  };
30153
30183
  };
30154
30184
  '/user_identities/enrollment_automations/delete': {
30155
30185
  post: {
30186
+ description: string;
30156
30187
  operationId: string;
30157
30188
  requestBody: {
30158
30189
  content: {
@@ -30160,6 +30191,7 @@ declare const _default: {
30160
30191
  schema: {
30161
30192
  properties: {
30162
30193
  enrollment_automation_id: {
30194
+ description: string;
30163
30195
  format: string;
30164
30196
  type: string;
30165
30197
  };
@@ -30212,10 +30244,12 @@ declare const _default: {
30212
30244
  'x-fern-sdk-group-name': string[];
30213
30245
  'x-fern-sdk-method-name': string;
30214
30246
  'x-response-key': null;
30247
+ 'x-title': string;
30215
30248
  };
30216
30249
  };
30217
30250
  '/user_identities/enrollment_automations/get': {
30218
30251
  post: {
30252
+ description: string;
30219
30253
  operationId: string;
30220
30254
  requestBody: {
30221
30255
  content: {
@@ -30223,6 +30257,7 @@ declare const _default: {
30223
30257
  schema: {
30224
30258
  properties: {
30225
30259
  enrollment_automation_id: {
30260
+ description: string;
30226
30261
  format: string;
30227
30262
  type: string;
30228
30263
  };
@@ -30287,10 +30322,12 @@ declare const _default: {
30287
30322
  'x-fern-sdk-method-name': string;
30288
30323
  'x-fern-sdk-return-value': string;
30289
30324
  'x-response-key': string;
30325
+ 'x-title': string;
30290
30326
  };
30291
30327
  };
30292
30328
  '/user_identities/enrollment_automations/launch': {
30293
30329
  post: {
30330
+ description: string;
30294
30331
  operationId: string;
30295
30332
  requestBody: {
30296
30333
  content: {
@@ -30298,21 +30335,26 @@ declare const _default: {
30298
30335
  schema: {
30299
30336
  properties: {
30300
30337
  acs_credential_pool_id: {
30338
+ description: string;
30301
30339
  format: string;
30302
30340
  type: string;
30303
30341
  };
30304
30342
  create_credential_manager_user: {
30343
+ description: string;
30305
30344
  type: string;
30306
30345
  };
30307
30346
  credential_manager_acs_system_id: {
30347
+ description: string;
30308
30348
  format: string;
30309
30349
  type: string;
30310
30350
  };
30311
30351
  credential_manager_acs_user_id: {
30352
+ description: string;
30312
30353
  format: string;
30313
30354
  type: string;
30314
30355
  };
30315
30356
  user_identity_id: {
30357
+ description: string;
30316
30358
  format: string;
30317
30359
  type: string;
30318
30360
  };
@@ -30396,10 +30438,12 @@ declare const _default: {
30396
30438
  'x-fern-sdk-method-name': string;
30397
30439
  'x-fern-sdk-return-value': string;
30398
30440
  'x-response-key': string;
30441
+ 'x-title': string;
30399
30442
  };
30400
30443
  };
30401
30444
  '/user_identities/enrollment_automations/list': {
30402
30445
  post: {
30446
+ description: string;
30403
30447
  operationId: string;
30404
30448
  requestBody: {
30405
30449
  content: {
@@ -30407,6 +30451,7 @@ declare const _default: {
30407
30451
  schema: {
30408
30452
  properties: {
30409
30453
  user_identity_id: {
30454
+ description: string;
30410
30455
  format: string;
30411
30456
  type: string;
30412
30457
  };
@@ -30474,10 +30519,12 @@ declare const _default: {
30474
30519
  'x-fern-sdk-method-name': string;
30475
30520
  'x-fern-sdk-return-value': string;
30476
30521
  'x-response-key': string;
30522
+ 'x-title': string;
30477
30523
  };
30478
30524
  };
30479
30525
  '/user_identities/get': {
30480
30526
  post: {
30527
+ description: string;
30481
30528
  operationId: string;
30482
30529
  requestBody: {
30483
30530
  content: {
@@ -30486,6 +30533,7 @@ declare const _default: {
30486
30533
  oneOf: ({
30487
30534
  properties: {
30488
30535
  user_identity_id: {
30536
+ description: string;
30489
30537
  format: string;
30490
30538
  type: string;
30491
30539
  };
@@ -30553,10 +30601,12 @@ declare const _default: {
30553
30601
  'x-fern-sdk-method-name': string;
30554
30602
  'x-fern-sdk-return-value': string;
30555
30603
  'x-response-key': string;
30604
+ 'x-title': string;
30556
30605
  };
30557
30606
  };
30558
30607
  '/user_identities/grant_access_to_device': {
30559
30608
  post: {
30609
+ description: string;
30560
30610
  operationId: string;
30561
30611
  requestBody: {
30562
30612
  content: {
@@ -30564,10 +30614,12 @@ declare const _default: {
30564
30614
  schema: {
30565
30615
  properties: {
30566
30616
  device_id: {
30617
+ description: string;
30567
30618
  format: string;
30568
30619
  type: string;
30569
30620
  };
30570
30621
  user_identity_id: {
30622
+ description: string;
30571
30623
  format: string;
30572
30624
  type: string;
30573
30625
  };
@@ -30620,8 +30672,10 @@ declare const _default: {
30620
30672
  'x-fern-sdk-group-name': string[];
30621
30673
  'x-fern-sdk-method-name': string;
30622
30674
  'x-response-key': null;
30675
+ 'x-title': string;
30623
30676
  };
30624
30677
  put: {
30678
+ description: string;
30625
30679
  operationId: string;
30626
30680
  requestBody: {
30627
30681
  content: {
@@ -30629,10 +30683,12 @@ declare const _default: {
30629
30683
  schema: {
30630
30684
  properties: {
30631
30685
  device_id: {
30686
+ description: string;
30632
30687
  format: string;
30633
30688
  type: string;
30634
30689
  };
30635
30690
  user_identity_id: {
30691
+ description: string;
30636
30692
  format: string;
30637
30693
  type: string;
30638
30694
  };
@@ -30684,10 +30740,12 @@ declare const _default: {
30684
30740
  tags: string[];
30685
30741
  'x-fern-ignore': boolean;
30686
30742
  'x-response-key': null;
30743
+ 'x-title': string;
30687
30744
  };
30688
30745
  };
30689
30746
  '/user_identities/list': {
30690
30747
  post: {
30748
+ description: string;
30691
30749
  operationId: string;
30692
30750
  requestBody: {
30693
30751
  content: {
@@ -30761,10 +30819,12 @@ declare const _default: {
30761
30819
  'x-fern-sdk-method-name': string;
30762
30820
  'x-fern-sdk-return-value': string;
30763
30821
  'x-response-key': string;
30822
+ 'x-title': string;
30764
30823
  };
30765
30824
  };
30766
30825
  '/user_identities/list_accessible_devices': {
30767
30826
  post: {
30827
+ description: string;
30768
30828
  operationId: string;
30769
30829
  requestBody: {
30770
30830
  content: {
@@ -30772,6 +30832,7 @@ declare const _default: {
30772
30832
  schema: {
30773
30833
  properties: {
30774
30834
  user_identity_id: {
30835
+ description: string;
30775
30836
  format: string;
30776
30837
  type: string;
30777
30838
  };
@@ -30839,10 +30900,12 @@ declare const _default: {
30839
30900
  'x-fern-sdk-method-name': string;
30840
30901
  'x-fern-sdk-return-value': string;
30841
30902
  'x-response-key': string;
30903
+ 'x-title': string;
30842
30904
  };
30843
30905
  };
30844
30906
  '/user_identities/list_acs_systems': {
30845
30907
  post: {
30908
+ description: string;
30846
30909
  operationId: string;
30847
30910
  requestBody: {
30848
30911
  content: {
@@ -30850,6 +30913,7 @@ declare const _default: {
30850
30913
  schema: {
30851
30914
  properties: {
30852
30915
  user_identity_id: {
30916
+ description: string;
30853
30917
  format: string;
30854
30918
  type: string;
30855
30919
  };
@@ -30917,10 +30981,12 @@ declare const _default: {
30917
30981
  'x-fern-sdk-method-name': string;
30918
30982
  'x-fern-sdk-return-value': string;
30919
30983
  'x-response-key': string;
30984
+ 'x-title': string;
30920
30985
  };
30921
30986
  };
30922
30987
  '/user_identities/list_acs_users': {
30923
30988
  post: {
30989
+ description: string;
30924
30990
  operationId: string;
30925
30991
  requestBody: {
30926
30992
  content: {
@@ -30928,6 +30994,7 @@ declare const _default: {
30928
30994
  schema: {
30929
30995
  properties: {
30930
30996
  user_identity_id: {
30997
+ description: string;
30931
30998
  format: string;
30932
30999
  type: string;
30933
31000
  };
@@ -30987,10 +31054,12 @@ declare const _default: {
30987
31054
  'x-fern-sdk-method-name': string;
30988
31055
  'x-fern-sdk-return-value': string;
30989
31056
  'x-response-key': string;
31057
+ 'x-title': string;
30990
31058
  };
30991
31059
  };
30992
31060
  '/user_identities/remove_acs_user': {
30993
31061
  post: {
31062
+ description: string;
30994
31063
  operationId: string;
30995
31064
  requestBody: {
30996
31065
  content: {
@@ -30998,10 +31067,12 @@ declare const _default: {
30998
31067
  schema: {
30999
31068
  properties: {
31000
31069
  acs_user_id: {
31070
+ description: string;
31001
31071
  format: string;
31002
31072
  type: string;
31003
31073
  };
31004
31074
  user_identity_id: {
31075
+ description: string;
31005
31076
  format: string;
31006
31077
  type: string;
31007
31078
  };
@@ -31054,10 +31125,12 @@ declare const _default: {
31054
31125
  'x-fern-sdk-group-name': string[];
31055
31126
  'x-fern-sdk-method-name': string;
31056
31127
  'x-response-key': null;
31128
+ 'x-title': string;
31057
31129
  };
31058
31130
  };
31059
31131
  '/user_identities/revoke_access_to_device': {
31060
31132
  post: {
31133
+ description: string;
31061
31134
  operationId: string;
31062
31135
  requestBody: {
31063
31136
  content: {
@@ -31065,10 +31138,12 @@ declare const _default: {
31065
31138
  schema: {
31066
31139
  properties: {
31067
31140
  device_id: {
31141
+ description: string;
31068
31142
  format: string;
31069
31143
  type: string;
31070
31144
  };
31071
31145
  user_identity_id: {
31146
+ description: string;
31072
31147
  format: string;
31073
31148
  type: string;
31074
31149
  };
@@ -31121,6 +31196,7 @@ declare const _default: {
31121
31196
  'x-fern-sdk-group-name': string[];
31122
31197
  'x-fern-sdk-method-name': string;
31123
31198
  'x-response-key': null;
31199
+ 'x-title': string;
31124
31200
  };
31125
31201
  };
31126
31202
  '/user_identities/update': {
@@ -31132,6 +31208,7 @@ declare const _default: {
31132
31208
  schema: {
31133
31209
  properties: {
31134
31210
  email_address: {
31211
+ description: string;
31135
31212
  format: string;
31136
31213
  nullable: boolean;
31137
31214
  type: string;
@@ -31142,14 +31219,17 @@ declare const _default: {
31142
31219
  type: string;
31143
31220
  };
31144
31221
  phone_number: {
31222
+ description: string;
31145
31223
  nullable: boolean;
31146
31224
  type: string;
31147
31225
  };
31148
31226
  user_identity_id: {
31227
+ description: string;
31149
31228
  format: string;
31150
31229
  type: string;
31151
31230
  };
31152
31231
  user_identity_key: {
31232
+ description: string;
31153
31233
  minLength: number;
31154
31234
  nullable: boolean;
31155
31235
  type: string;
@@ -31211,6 +31291,7 @@ declare const _default: {
31211
31291
  schema: {
31212
31292
  properties: {
31213
31293
  email_address: {
31294
+ description: string;
31214
31295
  format: string;
31215
31296
  nullable: boolean;
31216
31297
  type: string;
@@ -31221,14 +31302,17 @@ declare const _default: {
31221
31302
  type: string;
31222
31303
  };
31223
31304
  phone_number: {
31305
+ description: string;
31224
31306
  nullable: boolean;
31225
31307
  type: string;
31226
31308
  };
31227
31309
  user_identity_id: {
31310
+ description: string;
31228
31311
  format: string;
31229
31312
  type: string;
31230
31313
  };
31231
31314
  user_identity_key: {
31315
+ description: string;
31232
31316
  minLength: number;
31233
31317
  nullable: boolean;
31234
31318
  type: string;
@@ -56355,7 +56439,9 @@ interface Routes {
56355
56439
  queryParams: {};
56356
56440
  jsonBody: {};
56357
56441
  commonParams: {
56442
+ /** ID of the desired user identity. */
56358
56443
  user_identity_id: string;
56444
+ /** ID of the desired ACS user. */
56359
56445
  acs_user_id: string;
56360
56446
  };
56361
56447
  formData: {};
@@ -56367,21 +56453,32 @@ interface Routes {
56367
56453
  queryParams: {};
56368
56454
  jsonBody: {};
56369
56455
  commonParams: {
56456
+ /** Unique key for the user identity. */
56370
56457
  user_identity_key?: (string | null) | undefined;
56458
+ /** Unique email address for the user identity. */
56371
56459
  email_address?: (string | null) | undefined;
56460
+ /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
56372
56461
  phone_number?: (string | null) | undefined;
56462
+ /** Full name of the user associated with the user identity. */
56373
56463
  full_name?: (string | null) | undefined;
56374
56464
  };
56375
56465
  formData: {};
56376
56466
  jsonResponse: {
56467
+ /** 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
56468
  user_identity: {
56469
+ /** ID of the user identity. */
56378
56470
  user_identity_id: string;
56471
+ /** Unique key for the user identity. */
56379
56472
  user_identity_key: string | null;
56473
+ /** Unique email address for the user identity. */
56380
56474
  email_address: string | null;
56475
+ /** 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
56476
  phone_number: string | null;
56382
56477
  display_name: string;
56383
56478
  full_name: string | null;
56479
+ /** Date and time at which the user identity was created. */
56384
56480
  created_at: string;
56481
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
56385
56482
  workspace_id: string;
56386
56483
  };
56387
56484
  };
@@ -56392,6 +56489,7 @@ interface Routes {
56392
56489
  queryParams: {};
56393
56490
  jsonBody: {};
56394
56491
  commonParams: {
56492
+ /** ID of the desired user identity. */
56395
56493
  user_identity_id: string;
56396
56494
  };
56397
56495
  formData: {};
@@ -56403,6 +56501,7 @@ interface Routes {
56403
56501
  queryParams: {};
56404
56502
  jsonBody: {};
56405
56503
  commonParams: {
56504
+ /** ID of the desired enrollment automation. */
56406
56505
  enrollment_automation_id: string;
56407
56506
  };
56408
56507
  formData: {};
@@ -56414,16 +56513,23 @@ interface Routes {
56414
56513
  queryParams: {};
56415
56514
  jsonBody: {};
56416
56515
  commonParams: {
56516
+ /** ID of the desired enrollment automation. */
56417
56517
  enrollment_automation_id: string;
56418
56518
  };
56419
56519
  formData: {};
56420
56520
  jsonResponse: {
56521
+ /** 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
56522
  enrollment_automation: {
56523
+ /** ID of the enrollment automation. */
56524
+ enrollment_automation_id: string;
56525
+ /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
56422
56526
  credential_manager_acs_system_id: string;
56527
+ /** 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
56528
  user_identity_id: string;
56529
+ /** Date and time at which the enrollment automation was created. */
56424
56530
  created_at: string;
56531
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
56425
56532
  workspace_id: string;
56426
- enrollment_automation_id: string;
56427
56533
  };
56428
56534
  };
56429
56535
  };
@@ -56433,10 +56539,15 @@ interface Routes {
56433
56539
  queryParams: {};
56434
56540
  jsonBody: {};
56435
56541
  commonParams: {
56542
+ /** ID of the desired user identity. */
56436
56543
  user_identity_id: string;
56544
+ /** ID of the desired ACS system that serves as the credential manager. */
56437
56545
  credential_manager_acs_system_id: string;
56546
+ /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
56438
56547
  acs_credential_pool_id?: string | undefined;
56548
+ /** 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
56549
  create_credential_manager_user?: boolean | undefined;
56550
+ /** 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
56551
  credential_manager_acs_user_id?: string | undefined;
56441
56552
  };
56442
56553
  formData: {};
@@ -56457,16 +56568,22 @@ interface Routes {
56457
56568
  queryParams: {};
56458
56569
  jsonBody: {};
56459
56570
  commonParams: {
56571
+ /** ID of the user identity for which you want to retrieve all enrollment automations. */
56460
56572
  user_identity_id: string;
56461
56573
  };
56462
56574
  formData: {};
56463
56575
  jsonResponse: {
56464
56576
  enrollment_automations: Array<{
56577
+ /** ID of the enrollment automation. */
56578
+ enrollment_automation_id: string;
56579
+ /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
56465
56580
  credential_manager_acs_system_id: string;
56581
+ /** 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
56582
  user_identity_id: string;
56583
+ /** Date and time at which the enrollment automation was created. */
56467
56584
  created_at: string;
56585
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
56468
56586
  workspace_id: string;
56469
- enrollment_automation_id: string;
56470
56587
  }>;
56471
56588
  };
56472
56589
  };
@@ -56476,20 +56593,28 @@ interface Routes {
56476
56593
  queryParams: {};
56477
56594
  jsonBody: {};
56478
56595
  commonParams: {
56596
+ /** ID of the desired user identity. */
56479
56597
  user_identity_id: string;
56480
56598
  } | {
56481
56599
  user_identity_key: string;
56482
56600
  };
56483
56601
  formData: {};
56484
56602
  jsonResponse: {
56603
+ /** 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
56604
  user_identity: {
56605
+ /** ID of the user identity. */
56486
56606
  user_identity_id: string;
56607
+ /** Unique key for the user identity. */
56487
56608
  user_identity_key: string | null;
56609
+ /** Unique email address for the user identity. */
56488
56610
  email_address: string | null;
56611
+ /** 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
56612
  phone_number: string | null;
56490
56613
  display_name: string;
56491
56614
  full_name: string | null;
56615
+ /** Date and time at which the user identity was created. */
56492
56616
  created_at: string;
56617
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
56493
56618
  workspace_id: string;
56494
56619
  };
56495
56620
  };
@@ -56500,7 +56625,9 @@ interface Routes {
56500
56625
  queryParams: {};
56501
56626
  jsonBody: {};
56502
56627
  commonParams: {
56628
+ /** ID of the desired user identity. */
56503
56629
  user_identity_id: string;
56630
+ /** ID of the desired managed device. */
56504
56631
  device_id: string;
56505
56632
  };
56506
56633
  formData: {};
@@ -56517,13 +56644,19 @@ interface Routes {
56517
56644
  formData: {};
56518
56645
  jsonResponse: {
56519
56646
  user_identities: Array<{
56647
+ /** ID of the user identity. */
56520
56648
  user_identity_id: string;
56649
+ /** Unique key for the user identity. */
56521
56650
  user_identity_key: string | null;
56651
+ /** Unique email address for the user identity. */
56522
56652
  email_address: string | null;
56653
+ /** 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
56654
  phone_number: string | null;
56524
56655
  display_name: string;
56525
56656
  full_name: string | null;
56657
+ /** Date and time at which the user identity was created. */
56526
56658
  created_at: string;
56659
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
56527
56660
  workspace_id: string;
56528
56661
  }>;
56529
56662
  };
@@ -56534,6 +56667,7 @@ interface Routes {
56534
56667
  queryParams: {};
56535
56668
  jsonBody: {};
56536
56669
  commonParams: {
56670
+ /** ID of the user identity for which you want to retrieve all accessible devices. */
56537
56671
  user_identity_id: string;
56538
56672
  };
56539
56673
  formData: {};
@@ -57574,6 +57708,7 @@ interface Routes {
57574
57708
  queryParams: {};
57575
57709
  jsonBody: {};
57576
57710
  commonParams: {
57711
+ /** ID of the user identity for which you want to retrieve all access control systems. */
57577
57712
  user_identity_id: string;
57578
57713
  };
57579
57714
  formData: {};
@@ -57682,6 +57817,7 @@ interface Routes {
57682
57817
  queryParams: {};
57683
57818
  jsonBody: {};
57684
57819
  commonParams: {
57820
+ /** ID of the user identity for which you want to retrieve all ACS users. */
57685
57821
  user_identity_id: string;
57686
57822
  };
57687
57823
  formData: {};
@@ -57784,7 +57920,9 @@ interface Routes {
57784
57920
  queryParams: {};
57785
57921
  jsonBody: {};
57786
57922
  commonParams: {
57923
+ /** ID of the desired user identity. */
57787
57924
  user_identity_id: string;
57925
+ /** ID of the ACS user. */
57788
57926
  acs_user_id: string;
57789
57927
  };
57790
57928
  formData: {};
@@ -57796,7 +57934,9 @@ interface Routes {
57796
57934
  queryParams: {};
57797
57935
  jsonBody: {};
57798
57936
  commonParams: {
57937
+ /** ID of the desired user identity. */
57799
57938
  user_identity_id: string;
57939
+ /** ID of the desired managed device. */
57800
57940
  device_id: string;
57801
57941
  };
57802
57942
  formData: {};
@@ -57807,9 +57947,13 @@ interface Routes {
57807
57947
  method: 'PATCH' | 'POST';
57808
57948
  queryParams: {};
57809
57949
  jsonBody: {
57950
+ /** ID of the user identity. */
57810
57951
  user_identity_id: string;
57952
+ /** Unique key for the user identity. */
57811
57953
  user_identity_key?: (string | null) | undefined;
57954
+ /** Unique email address for the user identity. */
57812
57955
  email_address?: (string | null) | undefined;
57956
+ /** 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
57957
  phone_number?: (string | null) | undefined;
57814
57958
  full_name?: (string | null) | undefined;
57815
57959
  };