@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/lib/seam/connect/openapi.js CHANGED
@@ -4915,19 +4915,40 @@ export default {
4915
4915
  type: 'object',
4916
4916
  },
4917
4917
  enrollment_automation: {
4918
+ description: '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).',
4918
4919
  properties: {
4919
- created_at: { format: 'date-time', type: 'string' },
4920
- credential_manager_acs_system_id: { format: 'uuid', type: 'string' },
4921
- enrollment_automation_id: { format: 'uuid', type: 'string' },
4922
- user_identity_id: { format: 'uuid', type: 'string' },
4923
- workspace_id: { format: 'uuid', type: 'string' },
4920
+ created_at: {
4921
+ description: 'Date and time at which the enrollment automation was created.',
4922
+ format: 'date-time',
4923
+ type: 'string',
4924
+ },
4925
+ credential_manager_acs_system_id: {
4926
+ description: 'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.',
4927
+ format: 'uuid',
4928
+ type: 'string',
4929
+ },
4930
+ enrollment_automation_id: {
4931
+ description: 'ID of the enrollment automation.',
4932
+ format: 'uuid',
4933
+ type: 'string',
4934
+ },
4935
+ user_identity_id: {
4936
+ description: '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).',
4937
+ format: 'uuid',
4938
+ type: 'string',
4939
+ },
4940
+ workspace_id: {
4941
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.',
4942
+ format: 'uuid',
4943
+ type: 'string',
4944
+ },
4924
4945
  },
4925
4946
  required: [
4947
+ 'enrollment_automation_id',
4926
4948
  'credential_manager_acs_system_id',
4927
4949
  'user_identity_id',
4928
4950
  'created_at',
4929
4951
  'workspace_id',
4930
- 'enrollment_automation_id',
4931
4952
  ],
4932
4953
  type: 'object',
4933
4954
  },
@@ -5649,15 +5670,42 @@ export default {
5649
5670
  type: 'object',
5650
5671
  },
5651
5672
  user_identity: {
5673
+ description: '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.',
5652
5674
  properties: {
5653
- created_at: { format: 'date-time', type: 'string' },
5675
+ created_at: {
5676
+ description: 'Date and time at which the user identity was created.',
5677
+ format: 'date-time',
5678
+ type: 'string',
5679
+ },
5654
5680
  display_name: { minLength: 1, type: 'string' },
5655
- email_address: { format: 'email', nullable: true, type: 'string' },
5681
+ email_address: {
5682
+ description: 'Unique email address for the user identity.',
5683
+ format: 'email',
5684
+ nullable: true,
5685
+ type: 'string',
5686
+ },
5656
5687
  full_name: { minLength: 1, nullable: true, type: 'string' },
5657
- phone_number: { nullable: true, type: 'string' },
5658
- user_identity_id: { format: 'uuid', type: 'string' },
5659
- user_identity_key: { minLength: 1, nullable: true, type: 'string' },
5660
- workspace_id: { format: 'uuid', type: 'string' },
5688
+ phone_number: {
5689
+ description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
5690
+ nullable: true,
5691
+ type: 'string',
5692
+ },
5693
+ user_identity_id: {
5694
+ description: 'ID of the user identity.',
5695
+ format: 'uuid',
5696
+ type: 'string',
5697
+ },
5698
+ user_identity_key: {
5699
+ description: 'Unique key for the user identity.',
5700
+ minLength: 1,
5701
+ nullable: true,
5702
+ type: 'string',
5703
+ },
5704
+ workspace_id: {
5705
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
5706
+ format: 'uuid',
5707
+ type: 'string',
5708
+ },
5661
5709
  },
5662
5710
  required: [
5663
5711
  'user_identity_id',
@@ -16900,14 +16948,23 @@ export default {
16900
16948
  },
16901
16949
  '/user_identities/add_acs_user': {
16902
16950
  post: {
16951
+ description: 'Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [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).',
16903
16952
  operationId: 'userIdentitiesAddAcsUserPost',
16904
16953
  requestBody: {
16905
16954
  content: {
16906
16955
  'application/json': {
16907
16956
  schema: {
16908
16957
  properties: {
16909
- acs_user_id: { format: 'uuid', type: 'string' },
16910
- user_identity_id: { format: 'uuid', type: 'string' },
16958
+ acs_user_id: {
16959
+ description: 'ID of the desired ACS user.',
16960
+ format: 'uuid',
16961
+ type: 'string',
16962
+ },
16963
+ user_identity_id: {
16964
+ description: 'ID of the desired user identity.',
16965
+ format: 'uuid',
16966
+ type: 'string',
16967
+ },
16911
16968
  },
16912
16969
  required: ['user_identity_id', 'acs_user_id'],
16913
16970
  type: 'object',
@@ -16941,16 +16998,26 @@ export default {
16941
16998
  'x-fern-sdk-group-name': ['user_identities'],
16942
16999
  'x-fern-sdk-method-name': 'add_acs_user',
16943
17000
  'x-response-key': null,
17001
+ 'x-title': 'Add an ACS User to a User Identity',
16944
17002
  },
16945
17003
  put: {
17004
+ description: 'Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [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).',
16946
17005
  operationId: 'userIdentitiesAddAcsUserPut',
16947
17006
  requestBody: {
16948
17007
  content: {
16949
17008
  'application/json': {
16950
17009
  schema: {
16951
17010
  properties: {
16952
- acs_user_id: { format: 'uuid', type: 'string' },
16953
- user_identity_id: { format: 'uuid', type: 'string' },
17011
+ acs_user_id: {
17012
+ description: 'ID of the desired ACS user.',
17013
+ format: 'uuid',
17014
+ type: 'string',
17015
+ },
17016
+ user_identity_id: {
17017
+ description: 'ID of the desired user identity.',
17018
+ format: 'uuid',
17019
+ type: 'string',
17020
+ },
16954
17021
  },
16955
17022
  required: ['user_identity_id', 'acs_user_id'],
16956
17023
  type: 'object',
@@ -16983,10 +17050,12 @@ export default {
16983
17050
  tags: ['/user_identities'],
16984
17051
  'x-fern-ignore': true,
16985
17052
  'x-response-key': null,
17053
+ 'x-title': 'Add an ACS User to a User Identity',
16986
17054
  },
16987
17055
  },
16988
17056
  '/user_identities/create': {
16989
17057
  post: {
17058
+ description: 'Creates a new [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).',
16990
17059
  operationId: 'userIdentitiesCreatePost',
16991
17060
  requestBody: {
16992
17061
  content: {
@@ -16994,13 +17063,24 @@ export default {
16994
17063
  schema: {
16995
17064
  properties: {
16996
17065
  email_address: {
17066
+ description: 'Unique email address for the user identity.',
16997
17067
  format: 'email',
16998
17068
  nullable: true,
16999
17069
  type: 'string',
17000
17070
  },
17001
- full_name: { minLength: 1, nullable: true, type: 'string' },
17002
- phone_number: { nullable: true, type: 'string' },
17071
+ full_name: {
17072
+ description: 'Full name of the user associated with the user identity.',
17073
+ minLength: 1,
17074
+ nullable: true,
17075
+ type: 'string',
17076
+ },
17077
+ phone_number: {
17078
+ description: 'Unique phone number for the user identity in E.164 format (for example, +15555550100).',
17079
+ nullable: true,
17080
+ type: 'string',
17081
+ },
17003
17082
  user_identity_key: {
17083
+ description: 'Unique key for the user identity.',
17004
17084
  minLength: 1,
17005
17085
  nullable: true,
17006
17086
  type: 'string',
@@ -17043,17 +17123,23 @@ export default {
17043
17123
  'x-fern-sdk-method-name': 'create',
17044
17124
  'x-fern-sdk-return-value': 'user_identity',
17045
17125
  'x-response-key': 'user_identity',
17126
+ 'x-title': 'Create a User Identity',
17046
17127
  },
17047
17128
  },
17048
17129
  '/user_identities/delete': {
17049
17130
  post: {
17131
+ description: 'Deletes a specified [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). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.',
17050
17132
  operationId: 'userIdentitiesDeletePost',
17051
17133
  requestBody: {
17052
17134
  content: {
17053
17135
  'application/json': {
17054
17136
  schema: {
17055
17137
  properties: {
17056
- user_identity_id: { format: 'uuid', type: 'string' },
17138
+ user_identity_id: {
17139
+ description: 'ID of the desired user identity.',
17140
+ format: 'uuid',
17141
+ type: 'string',
17142
+ },
17057
17143
  },
17058
17144
  required: ['user_identity_id'],
17059
17145
  type: 'object',
@@ -17087,17 +17173,23 @@ export default {
17087
17173
  'x-fern-sdk-group-name': ['user_identities'],
17088
17174
  'x-fern-sdk-method-name': 'delete',
17089
17175
  'x-response-key': null,
17176
+ 'x-title': 'Delete a User Identity',
17090
17177
  },
17091
17178
  },
17092
17179
  '/user_identities/enrollment_automations/delete': {
17093
17180
  post: {
17181
+ description: 'Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with 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) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).',
17094
17182
  operationId: 'userIdentitiesEnrollmentAutomationsDeletePost',
17095
17183
  requestBody: {
17096
17184
  content: {
17097
17185
  'application/json': {
17098
17186
  schema: {
17099
17187
  properties: {
17100
- enrollment_automation_id: { format: 'uuid', type: 'string' },
17188
+ enrollment_automation_id: {
17189
+ description: 'ID of the desired enrollment automation.',
17190
+ format: 'uuid',
17191
+ type: 'string',
17192
+ },
17101
17193
  },
17102
17194
  required: ['enrollment_automation_id'],
17103
17195
  type: 'object',
@@ -17131,17 +17223,23 @@ export default {
17131
17223
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
17132
17224
  'x-fern-sdk-method-name': 'delete',
17133
17225
  'x-response-key': null,
17226
+ 'x-title': 'Delete an Enrollment Automation',
17134
17227
  },
17135
17228
  },
17136
17229
  '/user_identities/enrollment_automations/get': {
17137
17230
  post: {
17231
+ description: 'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).',
17138
17232
  operationId: 'userIdentitiesEnrollmentAutomationsGetPost',
17139
17233
  requestBody: {
17140
17234
  content: {
17141
17235
  'application/json': {
17142
17236
  schema: {
17143
17237
  properties: {
17144
- enrollment_automation_id: { format: 'uuid', type: 'string' },
17238
+ enrollment_automation_id: {
17239
+ description: 'ID of the desired enrollment automation.',
17240
+ format: 'uuid',
17241
+ type: 'string',
17242
+ },
17145
17243
  },
17146
17244
  required: ['enrollment_automation_id'],
17147
17245
  type: 'object',
@@ -17182,27 +17280,42 @@ export default {
17182
17280
  'x-fern-sdk-method-name': 'get',
17183
17281
  'x-fern-sdk-return-value': 'enrollment_automation',
17184
17282
  'x-response-key': 'enrollment_automation',
17283
+ 'x-title': 'Get an Enrollment Automation',
17185
17284
  },
17186
17285
  },
17187
17286
  '/user_identities/enrollment_automations/launch': {
17188
17287
  post: {
17288
+ description: 'Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).',
17189
17289
  operationId: 'userIdentitiesEnrollmentAutomationsLaunchPost',
17190
17290
  requestBody: {
17191
17291
  content: {
17192
17292
  'application/json': {
17193
17293
  schema: {
17194
17294
  properties: {
17195
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
17196
- create_credential_manager_user: { type: 'boolean' },
17295
+ acs_credential_pool_id: {
17296
+ description: 'ID of the ACS credential pool from which to obtain credentials for the user identity.',
17297
+ format: 'uuid',
17298
+ type: 'string',
17299
+ },
17300
+ create_credential_manager_user: {
17301
+ description: '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`.',
17302
+ type: 'boolean',
17303
+ },
17197
17304
  credential_manager_acs_system_id: {
17305
+ description: 'ID of the desired ACS system that serves as the credential manager.',
17198
17306
  format: 'uuid',
17199
17307
  type: 'string',
17200
17308
  },
17201
17309
  credential_manager_acs_user_id: {
17310
+ description: '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`.',
17311
+ format: 'uuid',
17312
+ type: 'string',
17313
+ },
17314
+ user_identity_id: {
17315
+ description: 'ID of the desired user identity.',
17202
17316
  format: 'uuid',
17203
17317
  type: 'string',
17204
17318
  },
17205
- user_identity_id: { format: 'uuid', type: 'string' },
17206
17319
  },
17207
17320
  required: [
17208
17321
  'user_identity_id',
@@ -17270,17 +17383,23 @@ export default {
17270
17383
  'x-fern-sdk-method-name': 'launch',
17271
17384
  'x-fern-sdk-return-value': 'enrollment_automation',
17272
17385
  'x-response-key': 'enrollment_automation',
17386
+ 'x-title': 'Launch an Enrollment Automation',
17273
17387
  },
17274
17388
  },
17275
17389
  '/user_identities/enrollment_automations/list': {
17276
17390
  post: {
17391
+ description: 'Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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).',
17277
17392
  operationId: 'userIdentitiesEnrollmentAutomationsListPost',
17278
17393
  requestBody: {
17279
17394
  content: {
17280
17395
  'application/json': {
17281
17396
  schema: {
17282
17397
  properties: {
17283
- user_identity_id: { format: 'uuid', type: 'string' },
17398
+ user_identity_id: {
17399
+ description: 'ID of the user identity for which you want to retrieve all enrollment automations.',
17400
+ format: 'uuid',
17401
+ type: 'string',
17402
+ },
17284
17403
  },
17285
17404
  required: ['user_identity_id'],
17286
17405
  type: 'object',
@@ -17324,10 +17443,12 @@ export default {
17324
17443
  'x-fern-sdk-method-name': 'list',
17325
17444
  'x-fern-sdk-return-value': 'enrollment_automations',
17326
17445
  'x-response-key': 'enrollment_automations',
17446
+ 'x-title': 'List Enrollment Automations',
17327
17447
  },
17328
17448
  },
17329
17449
  '/user_identities/get': {
17330
17450
  post: {
17451
+ description: 'Returns a specified [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).',
17331
17452
  operationId: 'userIdentitiesGetPost',
17332
17453
  requestBody: {
17333
17454
  content: {
@@ -17336,7 +17457,11 @@ export default {
17336
17457
  oneOf: [
17337
17458
  {
17338
17459
  properties: {
17339
- user_identity_id: { format: 'uuid', type: 'string' },
17460
+ user_identity_id: {
17461
+ description: 'ID of the desired user identity.',
17462
+ format: 'uuid',
17463
+ type: 'string',
17464
+ },
17340
17465
  },
17341
17466
  required: ['user_identity_id'],
17342
17467
  type: 'object',
@@ -17383,18 +17508,28 @@ export default {
17383
17508
  'x-fern-sdk-method-name': 'get',
17384
17509
  'x-fern-sdk-return-value': 'user_identity',
17385
17510
  'x-response-key': 'user_identity',
17511
+ 'x-title': 'Get a User Identity',
17386
17512
  },
17387
17513
  },
17388
17514
  '/user_identities/grant_access_to_device': {
17389
17515
  post: {
17516
+ description: 'Grants a specified [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) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).',
17390
17517
  operationId: 'userIdentitiesGrantAccessToDevicePost',
17391
17518
  requestBody: {
17392
17519
  content: {
17393
17520
  'application/json': {
17394
17521
  schema: {
17395
17522
  properties: {
17396
- device_id: { format: 'uuid', type: 'string' },
17397
- user_identity_id: { format: 'uuid', type: 'string' },
17523
+ device_id: {
17524
+ description: 'ID of the desired managed device.',
17525
+ format: 'uuid',
17526
+ type: 'string',
17527
+ },
17528
+ user_identity_id: {
17529
+ description: 'ID of the desired user identity.',
17530
+ format: 'uuid',
17531
+ type: 'string',
17532
+ },
17398
17533
  },
17399
17534
  required: ['user_identity_id', 'device_id'],
17400
17535
  type: 'object',
@@ -17428,16 +17563,26 @@ export default {
17428
17563
  'x-fern-sdk-group-name': ['user_identities'],
17429
17564
  'x-fern-sdk-method-name': 'grant_access_to_device',
17430
17565
  'x-response-key': null,
17566
+ 'x-title': 'Grant a User Identity Access to a Device',
17431
17567
  },
17432
17568
  put: {
17569
+ description: 'Grants a specified [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) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).',
17433
17570
  operationId: 'userIdentitiesGrantAccessToDevicePut',
17434
17571
  requestBody: {
17435
17572
  content: {
17436
17573
  'application/json': {
17437
17574
  schema: {
17438
17575
  properties: {
17439
- device_id: { format: 'uuid', type: 'string' },
17440
- user_identity_id: { format: 'uuid', type: 'string' },
17576
+ device_id: {
17577
+ description: 'ID of the desired managed device.',
17578
+ format: 'uuid',
17579
+ type: 'string',
17580
+ },
17581
+ user_identity_id: {
17582
+ description: 'ID of the desired user identity.',
17583
+ format: 'uuid',
17584
+ type: 'string',
17585
+ },
17441
17586
  },
17442
17587
  required: ['user_identity_id', 'device_id'],
17443
17588
  type: 'object',
@@ -17470,10 +17615,12 @@ export default {
17470
17615
  tags: ['/user_identities'],
17471
17616
  'x-fern-ignore': true,
17472
17617
  'x-response-key': null,
17618
+ 'x-title': 'Grant a User Identity Access to a Device',
17473
17619
  },
17474
17620
  },
17475
17621
  '/user_identities/list': {
17476
17622
  post: {
17623
+ description: 'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
17477
17624
  operationId: 'userIdentitiesListPost',
17478
17625
  requestBody: {
17479
17626
  content: {
@@ -17524,17 +17671,23 @@ export default {
17524
17671
  'x-fern-sdk-method-name': 'list',
17525
17672
  'x-fern-sdk-return-value': 'user_identities',
17526
17673
  'x-response-key': 'user_identities',
17674
+ 'x-title': 'List User Identities',
17527
17675
  },
17528
17676
  },
17529
17677
  '/user_identities/list_accessible_devices': {
17530
17678
  post: {
17679
+ description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [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).',
17531
17680
  operationId: 'userIdentitiesListAccessibleDevicesPost',
17532
17681
  requestBody: {
17533
17682
  content: {
17534
17683
  'application/json': {
17535
17684
  schema: {
17536
17685
  properties: {
17537
- user_identity_id: { format: 'uuid', type: 'string' },
17686
+ user_identity_id: {
17687
+ description: 'ID of the user identity for which you want to retrieve all accessible devices.',
17688
+ format: 'uuid',
17689
+ type: 'string',
17690
+ },
17538
17691
  },
17539
17692
  required: ['user_identity_id'],
17540
17693
  type: 'object',
@@ -17581,17 +17734,23 @@ export default {
17581
17734
  'x-fern-sdk-method-name': 'list_accessible_devices',
17582
17735
  'x-fern-sdk-return-value': 'devices',
17583
17736
  'x-response-key': 'devices',
17737
+ 'x-title': 'List Accessible Devices for a User Identity',
17584
17738
  },
17585
17739
  },
17586
17740
  '/user_identities/list_acs_systems': {
17587
17741
  post: {
17742
+ description: 'Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [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).',
17588
17743
  operationId: 'userIdentitiesListAcsSystemsPost',
17589
17744
  requestBody: {
17590
17745
  content: {
17591
17746
  'application/json': {
17592
17747
  schema: {
17593
17748
  properties: {
17594
- user_identity_id: { format: 'uuid', type: 'string' },
17749
+ user_identity_id: {
17750
+ description: 'ID of the user identity for which you want to retrieve all access control systems.',
17751
+ format: 'uuid',
17752
+ type: 'string',
17753
+ },
17595
17754
  },
17596
17755
  required: ['user_identity_id'],
17597
17756
  type: 'object',
@@ -17633,17 +17792,23 @@ export default {
17633
17792
  'x-fern-sdk-method-name': 'list_acs_systems',
17634
17793
  'x-fern-sdk-return-value': 'acs_systems',
17635
17794
  'x-response-key': 'acs_systems',
17795
+ 'x-title': 'List ACS Systems Associated with a User Identity',
17636
17796
  },
17637
17797
  },
17638
17798
  '/user_identities/list_acs_users': {
17639
17799
  post: {
17800
+ description: 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [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).',
17640
17801
  operationId: 'userIdentitiesListAcsUsersPost',
17641
17802
  requestBody: {
17642
17803
  content: {
17643
17804
  'application/json': {
17644
17805
  schema: {
17645
17806
  properties: {
17646
- user_identity_id: { format: 'uuid', type: 'string' },
17807
+ user_identity_id: {
17808
+ description: 'ID of the user identity for which you want to retrieve all ACS users.',
17809
+ format: 'uuid',
17810
+ type: 'string',
17811
+ },
17647
17812
  },
17648
17813
  required: ['user_identity_id'],
17649
17814
  type: 'object',
@@ -17684,18 +17849,28 @@ export default {
17684
17849
  'x-fern-sdk-method-name': 'list_acs_users',
17685
17850
  'x-fern-sdk-return-value': 'acs_users',
17686
17851
  'x-response-key': 'acs_users',
17852
+ 'x-title': 'List ACS Users Associated with a User Identity',
17687
17853
  },
17688
17854
  },
17689
17855
  '/user_identities/remove_acs_user': {
17690
17856
  post: {
17857
+ description: 'Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [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).',
17691
17858
  operationId: 'userIdentitiesRemoveAcsUserPost',
17692
17859
  requestBody: {
17693
17860
  content: {
17694
17861
  'application/json': {
17695
17862
  schema: {
17696
17863
  properties: {
17697
- acs_user_id: { format: 'uuid', type: 'string' },
17698
- user_identity_id: { format: 'uuid', type: 'string' },
17864
+ acs_user_id: {
17865
+ description: 'ID of the ACS user.',
17866
+ format: 'uuid',
17867
+ type: 'string',
17868
+ },
17869
+ user_identity_id: {
17870
+ description: 'ID of the desired user identity.',
17871
+ format: 'uuid',
17872
+ type: 'string',
17873
+ },
17699
17874
  },
17700
17875
  required: ['user_identity_id', 'acs_user_id'],
17701
17876
  type: 'object',
@@ -17729,18 +17904,28 @@ export default {
17729
17904
  'x-fern-sdk-group-name': ['user_identities'],
17730
17905
  'x-fern-sdk-method-name': 'remove_acs_user',
17731
17906
  'x-response-key': null,
17907
+ 'x-title': 'Remove an ACS User from a User Identity',
17732
17908
  },
17733
17909
  },
17734
17910
  '/user_identities/revoke_access_to_device': {
17735
17911
  post: {
17912
+ description: 'Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [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).',
17736
17913
  operationId: 'userIdentitiesRevokeAccessToDevicePost',
17737
17914
  requestBody: {
17738
17915
  content: {
17739
17916
  'application/json': {
17740
17917
  schema: {
17741
17918
  properties: {
17742
- device_id: { format: 'uuid', type: 'string' },
17743
- user_identity_id: { format: 'uuid', type: 'string' },
17919
+ device_id: {
17920
+ description: 'ID of the desired managed device.',
17921
+ format: 'uuid',
17922
+ type: 'string',
17923
+ },
17924
+ user_identity_id: {
17925
+ description: 'ID of the desired user identity.',
17926
+ format: 'uuid',
17927
+ type: 'string',
17928
+ },
17744
17929
  },
17745
17930
  required: ['user_identity_id', 'device_id'],
17746
17931
  type: 'object',
@@ -17774,6 +17959,7 @@ export default {
17774
17959
  'x-fern-sdk-group-name': ['user_identities'],
17775
17960
  'x-fern-sdk-method-name': 'revoke_access_to_device',
17776
17961
  'x-response-key': null,
17962
+ 'x-title': 'Revoke Access to a Device from a User Identity',
17777
17963
  },
17778
17964
  },
17779
17965
  '/user_identities/update': {
@@ -17785,14 +17971,24 @@ export default {
17785
17971
  schema: {
17786
17972
  properties: {
17787
17973
  email_address: {
17974
+ description: 'Unique email address for the user identity.',
17788
17975
  format: 'email',
17789
17976
  nullable: true,
17790
17977
  type: 'string',
17791
17978
  },
17792
17979
  full_name: { minLength: 1, nullable: true, type: 'string' },
17793
- phone_number: { nullable: true, type: 'string' },
17794
- user_identity_id: { format: 'uuid', type: 'string' },
17980
+ phone_number: {
17981
+ description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
17982
+ nullable: true,
17983
+ type: 'string',
17984
+ },
17985
+ user_identity_id: {
17986
+ description: 'ID of the user identity.',
17987
+ format: 'uuid',
17988
+ type: 'string',
17989
+ },
17795
17990
  user_identity_key: {
17991
+ description: 'Unique key for the user identity.',
17796
17992
  minLength: 1,
17797
17993
  nullable: true,
17798
17994
  type: 'string',
@@ -17838,14 +18034,24 @@ export default {
17838
18034
  schema: {
17839
18035
  properties: {
17840
18036
  email_address: {
18037
+ description: 'Unique email address for the user identity.',
17841
18038
  format: 'email',
17842
18039
  nullable: true,
17843
18040
  type: 'string',
17844
18041
  },
17845
18042
  full_name: { minLength: 1, nullable: true, type: 'string' },
17846
- phone_number: { nullable: true, type: 'string' },
17847
- user_identity_id: { format: 'uuid', type: 'string' },
18043
+ phone_number: {
18044
+ description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
18045
+ nullable: true,
18046
+ type: 'string',
18047
+ },
18048
+ user_identity_id: {
18049
+ description: 'ID of the user identity.',
18050
+ format: 'uuid',
18051
+ type: 'string',
18052
+ },
17848
18053
  user_identity_key: {
18054
+ description: 'Unique key for the user identity.',
17849
18055
  minLength: 1,
17850
18056
  nullable: true,
17851
18057
  type: 'string',