@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/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',
@@ -6947,6 +6995,7 @@ export default {
6947
6995
  summary: '/access_codes/update_multiple',
6948
6996
  tags: ['/access_codes'],
6949
6997
  'x-fern-ignore': true,
6998
+ 'x-response-key': null,
6950
6999
  },
6951
7000
  post: {
6952
7001
  operationId: 'accessCodesUpdateMultiplePost',
@@ -6992,6 +7041,7 @@ export default {
6992
7041
  tags: ['/access_codes'],
6993
7042
  'x-fern-sdk-group-name': ['access_codes'],
6994
7043
  'x-fern-sdk-method-name': 'update_multiple',
7044
+ 'x-response-key': null,
6995
7045
  },
6996
7046
  },
6997
7047
  '/acs/access_groups/add_user': {
@@ -16900,14 +16950,23 @@ export default {
16900
16950
  },
16901
16951
  '/user_identities/add_acs_user': {
16902
16952
  post: {
16953
+ 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
16954
  operationId: 'userIdentitiesAddAcsUserPost',
16904
16955
  requestBody: {
16905
16956
  content: {
16906
16957
  'application/json': {
16907
16958
  schema: {
16908
16959
  properties: {
16909
- acs_user_id: { format: 'uuid', type: 'string' },
16910
- user_identity_id: { format: 'uuid', type: 'string' },
16960
+ acs_user_id: {
16961
+ description: 'ID of the desired ACS user.',
16962
+ format: 'uuid',
16963
+ type: 'string',
16964
+ },
16965
+ user_identity_id: {
16966
+ description: 'ID of the desired user identity.',
16967
+ format: 'uuid',
16968
+ type: 'string',
16969
+ },
16911
16970
  },
16912
16971
  required: ['user_identity_id', 'acs_user_id'],
16913
16972
  type: 'object',
@@ -16941,16 +17000,26 @@ export default {
16941
17000
  'x-fern-sdk-group-name': ['user_identities'],
16942
17001
  'x-fern-sdk-method-name': 'add_acs_user',
16943
17002
  'x-response-key': null,
17003
+ 'x-title': 'Add an ACS User to a User Identity',
16944
17004
  },
16945
17005
  put: {
17006
+ 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
17007
  operationId: 'userIdentitiesAddAcsUserPut',
16947
17008
  requestBody: {
16948
17009
  content: {
16949
17010
  'application/json': {
16950
17011
  schema: {
16951
17012
  properties: {
16952
- acs_user_id: { format: 'uuid', type: 'string' },
16953
- user_identity_id: { format: 'uuid', type: 'string' },
17013
+ acs_user_id: {
17014
+ description: 'ID of the desired ACS user.',
17015
+ format: 'uuid',
17016
+ type: 'string',
17017
+ },
17018
+ user_identity_id: {
17019
+ description: 'ID of the desired user identity.',
17020
+ format: 'uuid',
17021
+ type: 'string',
17022
+ },
16954
17023
  },
16955
17024
  required: ['user_identity_id', 'acs_user_id'],
16956
17025
  type: 'object',
@@ -16983,10 +17052,12 @@ export default {
16983
17052
  tags: ['/user_identities'],
16984
17053
  'x-fern-ignore': true,
16985
17054
  'x-response-key': null,
17055
+ 'x-title': 'Add an ACS User to a User Identity',
16986
17056
  },
16987
17057
  },
16988
17058
  '/user_identities/create': {
16989
17059
  post: {
17060
+ 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
17061
  operationId: 'userIdentitiesCreatePost',
16991
17062
  requestBody: {
16992
17063
  content: {
@@ -16994,13 +17065,24 @@ export default {
16994
17065
  schema: {
16995
17066
  properties: {
16996
17067
  email_address: {
17068
+ description: 'Unique email address for the user identity.',
16997
17069
  format: 'email',
16998
17070
  nullable: true,
16999
17071
  type: 'string',
17000
17072
  },
17001
- full_name: { minLength: 1, nullable: true, type: 'string' },
17002
- phone_number: { nullable: true, type: 'string' },
17073
+ full_name: {
17074
+ description: 'Full name of the user associated with the user identity.',
17075
+ minLength: 1,
17076
+ nullable: true,
17077
+ type: 'string',
17078
+ },
17079
+ phone_number: {
17080
+ description: 'Unique phone number for the user identity in E.164 format (for example, +15555550100).',
17081
+ nullable: true,
17082
+ type: 'string',
17083
+ },
17003
17084
  user_identity_key: {
17085
+ description: 'Unique key for the user identity.',
17004
17086
  minLength: 1,
17005
17087
  nullable: true,
17006
17088
  type: 'string',
@@ -17043,17 +17125,23 @@ export default {
17043
17125
  'x-fern-sdk-method-name': 'create',
17044
17126
  'x-fern-sdk-return-value': 'user_identity',
17045
17127
  'x-response-key': 'user_identity',
17128
+ 'x-title': 'Create a User Identity',
17046
17129
  },
17047
17130
  },
17048
17131
  '/user_identities/delete': {
17049
17132
  post: {
17133
+ 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
17134
  operationId: 'userIdentitiesDeletePost',
17051
17135
  requestBody: {
17052
17136
  content: {
17053
17137
  'application/json': {
17054
17138
  schema: {
17055
17139
  properties: {
17056
- user_identity_id: { format: 'uuid', type: 'string' },
17140
+ user_identity_id: {
17141
+ description: 'ID of the desired user identity.',
17142
+ format: 'uuid',
17143
+ type: 'string',
17144
+ },
17057
17145
  },
17058
17146
  required: ['user_identity_id'],
17059
17147
  type: 'object',
@@ -17087,17 +17175,23 @@ export default {
17087
17175
  'x-fern-sdk-group-name': ['user_identities'],
17088
17176
  'x-fern-sdk-method-name': 'delete',
17089
17177
  'x-response-key': null,
17178
+ 'x-title': 'Delete a User Identity',
17090
17179
  },
17091
17180
  },
17092
17181
  '/user_identities/enrollment_automations/delete': {
17093
17182
  post: {
17183
+ 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
17184
  operationId: 'userIdentitiesEnrollmentAutomationsDeletePost',
17095
17185
  requestBody: {
17096
17186
  content: {
17097
17187
  'application/json': {
17098
17188
  schema: {
17099
17189
  properties: {
17100
- enrollment_automation_id: { format: 'uuid', type: 'string' },
17190
+ enrollment_automation_id: {
17191
+ description: 'ID of the desired enrollment automation.',
17192
+ format: 'uuid',
17193
+ type: 'string',
17194
+ },
17101
17195
  },
17102
17196
  required: ['enrollment_automation_id'],
17103
17197
  type: 'object',
@@ -17131,17 +17225,23 @@ export default {
17131
17225
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
17132
17226
  'x-fern-sdk-method-name': 'delete',
17133
17227
  'x-response-key': null,
17228
+ 'x-title': 'Delete an Enrollment Automation',
17134
17229
  },
17135
17230
  },
17136
17231
  '/user_identities/enrollment_automations/get': {
17137
17232
  post: {
17233
+ 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
17234
  operationId: 'userIdentitiesEnrollmentAutomationsGetPost',
17139
17235
  requestBody: {
17140
17236
  content: {
17141
17237
  'application/json': {
17142
17238
  schema: {
17143
17239
  properties: {
17144
- enrollment_automation_id: { format: 'uuid', type: 'string' },
17240
+ enrollment_automation_id: {
17241
+ description: 'ID of the desired enrollment automation.',
17242
+ format: 'uuid',
17243
+ type: 'string',
17244
+ },
17145
17245
  },
17146
17246
  required: ['enrollment_automation_id'],
17147
17247
  type: 'object',
@@ -17182,27 +17282,42 @@ export default {
17182
17282
  'x-fern-sdk-method-name': 'get',
17183
17283
  'x-fern-sdk-return-value': 'enrollment_automation',
17184
17284
  'x-response-key': 'enrollment_automation',
17285
+ 'x-title': 'Get an Enrollment Automation',
17185
17286
  },
17186
17287
  },
17187
17288
  '/user_identities/enrollment_automations/launch': {
17188
17289
  post: {
17290
+ 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
17291
  operationId: 'userIdentitiesEnrollmentAutomationsLaunchPost',
17190
17292
  requestBody: {
17191
17293
  content: {
17192
17294
  'application/json': {
17193
17295
  schema: {
17194
17296
  properties: {
17195
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
17196
- create_credential_manager_user: { type: 'boolean' },
17297
+ acs_credential_pool_id: {
17298
+ description: 'ID of the ACS credential pool from which to obtain credentials for the user identity.',
17299
+ format: 'uuid',
17300
+ type: 'string',
17301
+ },
17302
+ create_credential_manager_user: {
17303
+ 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`.',
17304
+ type: 'boolean',
17305
+ },
17197
17306
  credential_manager_acs_system_id: {
17307
+ description: 'ID of the desired ACS system that serves as the credential manager.',
17198
17308
  format: 'uuid',
17199
17309
  type: 'string',
17200
17310
  },
17201
17311
  credential_manager_acs_user_id: {
17312
+ 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`.',
17313
+ format: 'uuid',
17314
+ type: 'string',
17315
+ },
17316
+ user_identity_id: {
17317
+ description: 'ID of the desired user identity.',
17202
17318
  format: 'uuid',
17203
17319
  type: 'string',
17204
17320
  },
17205
- user_identity_id: { format: 'uuid', type: 'string' },
17206
17321
  },
17207
17322
  required: [
17208
17323
  'user_identity_id',
@@ -17270,17 +17385,23 @@ export default {
17270
17385
  'x-fern-sdk-method-name': 'launch',
17271
17386
  'x-fern-sdk-return-value': 'enrollment_automation',
17272
17387
  'x-response-key': 'enrollment_automation',
17388
+ 'x-title': 'Launch an Enrollment Automation',
17273
17389
  },
17274
17390
  },
17275
17391
  '/user_identities/enrollment_automations/list': {
17276
17392
  post: {
17393
+ 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
17394
  operationId: 'userIdentitiesEnrollmentAutomationsListPost',
17278
17395
  requestBody: {
17279
17396
  content: {
17280
17397
  'application/json': {
17281
17398
  schema: {
17282
17399
  properties: {
17283
- user_identity_id: { format: 'uuid', type: 'string' },
17400
+ user_identity_id: {
17401
+ description: 'ID of the user identity for which you want to retrieve all enrollment automations.',
17402
+ format: 'uuid',
17403
+ type: 'string',
17404
+ },
17284
17405
  },
17285
17406
  required: ['user_identity_id'],
17286
17407
  type: 'object',
@@ -17324,10 +17445,12 @@ export default {
17324
17445
  'x-fern-sdk-method-name': 'list',
17325
17446
  'x-fern-sdk-return-value': 'enrollment_automations',
17326
17447
  'x-response-key': 'enrollment_automations',
17448
+ 'x-title': 'List Enrollment Automations',
17327
17449
  },
17328
17450
  },
17329
17451
  '/user_identities/get': {
17330
17452
  post: {
17453
+ 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
17454
  operationId: 'userIdentitiesGetPost',
17332
17455
  requestBody: {
17333
17456
  content: {
@@ -17336,7 +17459,11 @@ export default {
17336
17459
  oneOf: [
17337
17460
  {
17338
17461
  properties: {
17339
- user_identity_id: { format: 'uuid', type: 'string' },
17462
+ user_identity_id: {
17463
+ description: 'ID of the desired user identity.',
17464
+ format: 'uuid',
17465
+ type: 'string',
17466
+ },
17340
17467
  },
17341
17468
  required: ['user_identity_id'],
17342
17469
  type: 'object',
@@ -17383,18 +17510,28 @@ export default {
17383
17510
  'x-fern-sdk-method-name': 'get',
17384
17511
  'x-fern-sdk-return-value': 'user_identity',
17385
17512
  'x-response-key': 'user_identity',
17513
+ 'x-title': 'Get a User Identity',
17386
17514
  },
17387
17515
  },
17388
17516
  '/user_identities/grant_access_to_device': {
17389
17517
  post: {
17518
+ 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
17519
  operationId: 'userIdentitiesGrantAccessToDevicePost',
17391
17520
  requestBody: {
17392
17521
  content: {
17393
17522
  'application/json': {
17394
17523
  schema: {
17395
17524
  properties: {
17396
- device_id: { format: 'uuid', type: 'string' },
17397
- user_identity_id: { format: 'uuid', type: 'string' },
17525
+ device_id: {
17526
+ description: 'ID of the desired managed device.',
17527
+ format: 'uuid',
17528
+ type: 'string',
17529
+ },
17530
+ user_identity_id: {
17531
+ description: 'ID of the desired user identity.',
17532
+ format: 'uuid',
17533
+ type: 'string',
17534
+ },
17398
17535
  },
17399
17536
  required: ['user_identity_id', 'device_id'],
17400
17537
  type: 'object',
@@ -17428,16 +17565,26 @@ export default {
17428
17565
  'x-fern-sdk-group-name': ['user_identities'],
17429
17566
  'x-fern-sdk-method-name': 'grant_access_to_device',
17430
17567
  'x-response-key': null,
17568
+ 'x-title': 'Grant a User Identity Access to a Device',
17431
17569
  },
17432
17570
  put: {
17571
+ 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
17572
  operationId: 'userIdentitiesGrantAccessToDevicePut',
17434
17573
  requestBody: {
17435
17574
  content: {
17436
17575
  'application/json': {
17437
17576
  schema: {
17438
17577
  properties: {
17439
- device_id: { format: 'uuid', type: 'string' },
17440
- user_identity_id: { format: 'uuid', type: 'string' },
17578
+ device_id: {
17579
+ description: 'ID of the desired managed device.',
17580
+ format: 'uuid',
17581
+ type: 'string',
17582
+ },
17583
+ user_identity_id: {
17584
+ description: 'ID of the desired user identity.',
17585
+ format: 'uuid',
17586
+ type: 'string',
17587
+ },
17441
17588
  },
17442
17589
  required: ['user_identity_id', 'device_id'],
17443
17590
  type: 'object',
@@ -17470,10 +17617,12 @@ export default {
17470
17617
  tags: ['/user_identities'],
17471
17618
  'x-fern-ignore': true,
17472
17619
  'x-response-key': null,
17620
+ 'x-title': 'Grant a User Identity Access to a Device',
17473
17621
  },
17474
17622
  },
17475
17623
  '/user_identities/list': {
17476
17624
  post: {
17625
+ 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
17626
  operationId: 'userIdentitiesListPost',
17478
17627
  requestBody: {
17479
17628
  content: {
@@ -17524,17 +17673,23 @@ export default {
17524
17673
  'x-fern-sdk-method-name': 'list',
17525
17674
  'x-fern-sdk-return-value': 'user_identities',
17526
17675
  'x-response-key': 'user_identities',
17676
+ 'x-title': 'List User Identities',
17527
17677
  },
17528
17678
  },
17529
17679
  '/user_identities/list_accessible_devices': {
17530
17680
  post: {
17681
+ 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
17682
  operationId: 'userIdentitiesListAccessibleDevicesPost',
17532
17683
  requestBody: {
17533
17684
  content: {
17534
17685
  'application/json': {
17535
17686
  schema: {
17536
17687
  properties: {
17537
- user_identity_id: { format: 'uuid', type: 'string' },
17688
+ user_identity_id: {
17689
+ description: 'ID of the user identity for which you want to retrieve all accessible devices.',
17690
+ format: 'uuid',
17691
+ type: 'string',
17692
+ },
17538
17693
  },
17539
17694
  required: ['user_identity_id'],
17540
17695
  type: 'object',
@@ -17581,17 +17736,23 @@ export default {
17581
17736
  'x-fern-sdk-method-name': 'list_accessible_devices',
17582
17737
  'x-fern-sdk-return-value': 'devices',
17583
17738
  'x-response-key': 'devices',
17739
+ 'x-title': 'List Accessible Devices for a User Identity',
17584
17740
  },
17585
17741
  },
17586
17742
  '/user_identities/list_acs_systems': {
17587
17743
  post: {
17744
+ 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
17745
  operationId: 'userIdentitiesListAcsSystemsPost',
17589
17746
  requestBody: {
17590
17747
  content: {
17591
17748
  'application/json': {
17592
17749
  schema: {
17593
17750
  properties: {
17594
- user_identity_id: { format: 'uuid', type: 'string' },
17751
+ user_identity_id: {
17752
+ description: 'ID of the user identity for which you want to retrieve all access control systems.',
17753
+ format: 'uuid',
17754
+ type: 'string',
17755
+ },
17595
17756
  },
17596
17757
  required: ['user_identity_id'],
17597
17758
  type: 'object',
@@ -17633,17 +17794,23 @@ export default {
17633
17794
  'x-fern-sdk-method-name': 'list_acs_systems',
17634
17795
  'x-fern-sdk-return-value': 'acs_systems',
17635
17796
  'x-response-key': 'acs_systems',
17797
+ 'x-title': 'List ACS Systems Associated with a User Identity',
17636
17798
  },
17637
17799
  },
17638
17800
  '/user_identities/list_acs_users': {
17639
17801
  post: {
17802
+ 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
17803
  operationId: 'userIdentitiesListAcsUsersPost',
17641
17804
  requestBody: {
17642
17805
  content: {
17643
17806
  'application/json': {
17644
17807
  schema: {
17645
17808
  properties: {
17646
- user_identity_id: { format: 'uuid', type: 'string' },
17809
+ user_identity_id: {
17810
+ description: 'ID of the user identity for which you want to retrieve all ACS users.',
17811
+ format: 'uuid',
17812
+ type: 'string',
17813
+ },
17647
17814
  },
17648
17815
  required: ['user_identity_id'],
17649
17816
  type: 'object',
@@ -17684,18 +17851,28 @@ export default {
17684
17851
  'x-fern-sdk-method-name': 'list_acs_users',
17685
17852
  'x-fern-sdk-return-value': 'acs_users',
17686
17853
  'x-response-key': 'acs_users',
17854
+ 'x-title': 'List ACS Users Associated with a User Identity',
17687
17855
  },
17688
17856
  },
17689
17857
  '/user_identities/remove_acs_user': {
17690
17858
  post: {
17859
+ 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
17860
  operationId: 'userIdentitiesRemoveAcsUserPost',
17692
17861
  requestBody: {
17693
17862
  content: {
17694
17863
  'application/json': {
17695
17864
  schema: {
17696
17865
  properties: {
17697
- acs_user_id: { format: 'uuid', type: 'string' },
17698
- user_identity_id: { format: 'uuid', type: 'string' },
17866
+ acs_user_id: {
17867
+ description: 'ID of the ACS user.',
17868
+ format: 'uuid',
17869
+ type: 'string',
17870
+ },
17871
+ user_identity_id: {
17872
+ description: 'ID of the desired user identity.',
17873
+ format: 'uuid',
17874
+ type: 'string',
17875
+ },
17699
17876
  },
17700
17877
  required: ['user_identity_id', 'acs_user_id'],
17701
17878
  type: 'object',
@@ -17729,18 +17906,28 @@ export default {
17729
17906
  'x-fern-sdk-group-name': ['user_identities'],
17730
17907
  'x-fern-sdk-method-name': 'remove_acs_user',
17731
17908
  'x-response-key': null,
17909
+ 'x-title': 'Remove an ACS User from a User Identity',
17732
17910
  },
17733
17911
  },
17734
17912
  '/user_identities/revoke_access_to_device': {
17735
17913
  post: {
17914
+ 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
17915
  operationId: 'userIdentitiesRevokeAccessToDevicePost',
17737
17916
  requestBody: {
17738
17917
  content: {
17739
17918
  'application/json': {
17740
17919
  schema: {
17741
17920
  properties: {
17742
- device_id: { format: 'uuid', type: 'string' },
17743
- user_identity_id: { format: 'uuid', type: 'string' },
17921
+ device_id: {
17922
+ description: 'ID of the desired managed device.',
17923
+ format: 'uuid',
17924
+ type: 'string',
17925
+ },
17926
+ user_identity_id: {
17927
+ description: 'ID of the desired user identity.',
17928
+ format: 'uuid',
17929
+ type: 'string',
17930
+ },
17744
17931
  },
17745
17932
  required: ['user_identity_id', 'device_id'],
17746
17933
  type: 'object',
@@ -17774,6 +17961,7 @@ export default {
17774
17961
  'x-fern-sdk-group-name': ['user_identities'],
17775
17962
  'x-fern-sdk-method-name': 'revoke_access_to_device',
17776
17963
  'x-response-key': null,
17964
+ 'x-title': 'Revoke Access to a Device from a User Identity',
17777
17965
  },
17778
17966
  },
17779
17967
  '/user_identities/update': {
@@ -17785,14 +17973,24 @@ export default {
17785
17973
  schema: {
17786
17974
  properties: {
17787
17975
  email_address: {
17976
+ description: 'Unique email address for the user identity.',
17788
17977
  format: 'email',
17789
17978
  nullable: true,
17790
17979
  type: 'string',
17791
17980
  },
17792
17981
  full_name: { minLength: 1, nullable: true, type: 'string' },
17793
- phone_number: { nullable: true, type: 'string' },
17794
- user_identity_id: { format: 'uuid', type: 'string' },
17982
+ phone_number: {
17983
+ 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).',
17984
+ nullable: true,
17985
+ type: 'string',
17986
+ },
17987
+ user_identity_id: {
17988
+ description: 'ID of the user identity.',
17989
+ format: 'uuid',
17990
+ type: 'string',
17991
+ },
17795
17992
  user_identity_key: {
17993
+ description: 'Unique key for the user identity.',
17796
17994
  minLength: 1,
17797
17995
  nullable: true,
17798
17996
  type: 'string',
@@ -17838,14 +18036,24 @@ export default {
17838
18036
  schema: {
17839
18037
  properties: {
17840
18038
  email_address: {
18039
+ description: 'Unique email address for the user identity.',
17841
18040
  format: 'email',
17842
18041
  nullable: true,
17843
18042
  type: 'string',
17844
18043
  },
17845
18044
  full_name: { minLength: 1, nullable: true, type: 'string' },
17846
- phone_number: { nullable: true, type: 'string' },
17847
- user_identity_id: { format: 'uuid', type: 'string' },
18045
+ phone_number: {
18046
+ 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).',
18047
+ nullable: true,
18048
+ type: 'string',
18049
+ },
18050
+ user_identity_id: {
18051
+ description: 'ID of the user identity.',
18052
+ format: 'uuid',
18053
+ type: 'string',
18054
+ },
17848
18055
  user_identity_key: {
18056
+ description: 'Unique key for the user identity.',
17849
18057
  minLength: 1,
17850
18058
  nullable: true,
17851
18059
  type: 'string',