@seamapi/types 1.293.0 → 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 (20) hide show
  1. package/dist/connect.cjs +300 -81
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +238 -45
  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/thermostats/climate-preset.js +5 -3
  8. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  9. package/lib/seam/connect/models/user-identities/user-identity.js +26 -8
  10. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  11. package/lib/seam/connect/openapi.d.ts +95 -1
  12. package/lib/seam/connect/openapi.js +259 -50
  13. package/lib/seam/connect/openapi.js.map +1 -1
  14. package/lib/seam/connect/route-types.d.ts +143 -44
  15. package/package.json +1 -1
  16. package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +32 -7
  17. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +7 -5
  18. package/src/lib/seam/connect/models/user-identities/user-identity.ts +34 -10
  19. package/src/lib/seam/connect/openapi.ts +302 -51
  20. package/src/lib/seam/connect/route-types.ts +143 -44
package/lib/seam/connect/openapi.js CHANGED
@@ -4524,8 +4524,10 @@ export default {
4524
4524
  type: 'string',
4525
4525
  },
4526
4526
  manual_override_allowed: {
4527
+ deprecated: true,
4527
4528
  description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4528
4529
  type: 'boolean',
4530
+ 'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
4529
4531
  },
4530
4532
  name: {
4531
4533
  default: null,
@@ -4608,8 +4610,10 @@ export default {
4608
4610
  type: 'string',
4609
4611
  },
4610
4612
  manual_override_allowed: {
4613
+ deprecated: true,
4611
4614
  description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4612
4615
  type: 'boolean',
4616
+ 'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
4613
4617
  },
4614
4618
  name: {
4615
4619
  default: null,
@@ -4670,8 +4674,10 @@ export default {
4670
4674
  type: 'string',
4671
4675
  },
4672
4676
  manual_override_allowed: {
4677
+ deprecated: true,
4673
4678
  description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4674
4679
  type: 'boolean',
4680
+ 'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
4675
4681
  },
4676
4682
  name: {
4677
4683
  default: null,
@@ -4909,19 +4915,40 @@ export default {
4909
4915
  type: 'object',
4910
4916
  },
4911
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).',
4912
4919
  properties: {
4913
- created_at: { format: 'date-time', type: 'string' },
4914
- credential_manager_acs_system_id: { format: 'uuid', type: 'string' },
4915
- enrollment_automation_id: { format: 'uuid', type: 'string' },
4916
- user_identity_id: { format: 'uuid', type: 'string' },
4917
- 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
+ },
4918
4945
  },
4919
4946
  required: [
4947
+ 'enrollment_automation_id',
4920
4948
  'credential_manager_acs_system_id',
4921
4949
  'user_identity_id',
4922
4950
  'created_at',
4923
4951
  'workspace_id',
4924
- 'enrollment_automation_id',
4925
4952
  ],
4926
4953
  type: 'object',
4927
4954
  },
@@ -5643,15 +5670,42 @@ export default {
5643
5670
  type: 'object',
5644
5671
  },
5645
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.',
5646
5674
  properties: {
5647
- 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
+ },
5648
5680
  display_name: { minLength: 1, type: 'string' },
5649
- 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
+ },
5650
5687
  full_name: { minLength: 1, nullable: true, type: 'string' },
5651
- phone_number: { nullable: true, type: 'string' },
5652
- user_identity_id: { format: 'uuid', type: 'string' },
5653
- user_identity_key: { minLength: 1, nullable: true, type: 'string' },
5654
- 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
+ },
5655
5709
  },
5656
5710
  required: [
5657
5711
  'user_identity_id',
@@ -15348,10 +15402,7 @@ export default {
15348
15402
  enum: ['off', 'heat', 'cool', 'heat_cool'],
15349
15403
  type: 'string',
15350
15404
  },
15351
- manual_override_allowed: {
15352
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
15353
- type: 'boolean',
15354
- },
15405
+ manual_override_allowed: { default: true, type: 'boolean' },
15355
15406
  name: {
15356
15407
  default: null,
15357
15408
  description: 'User-friendly name to identify the climate preset.',
@@ -15359,11 +15410,7 @@ export default {
15359
15410
  type: 'string',
15360
15411
  },
15361
15412
  },
15362
- required: [
15363
- 'device_id',
15364
- 'climate_preset_key',
15365
- 'manual_override_allowed',
15366
- ],
15413
+ required: ['device_id', 'climate_preset_key'],
15367
15414
  type: 'object',
15368
15415
  },
15369
15416
  },
@@ -16751,8 +16798,10 @@ export default {
16751
16798
  type: 'string',
16752
16799
  },
16753
16800
  manual_override_allowed: {
16801
+ deprecated: true,
16754
16802
  description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
16755
16803
  type: 'boolean',
16804
+ 'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
16756
16805
  },
16757
16806
  name: {
16758
16807
  default: null,
@@ -16846,8 +16895,10 @@ export default {
16846
16895
  type: 'string',
16847
16896
  },
16848
16897
  manual_override_allowed: {
16898
+ deprecated: true,
16849
16899
  description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
16850
16900
  type: 'boolean',
16901
+ 'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
16851
16902
  },
16852
16903
  name: {
16853
16904
  default: null,
@@ -16897,14 +16948,23 @@ export default {
16897
16948
  },
16898
16949
  '/user_identities/add_acs_user': {
16899
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).',
16900
16952
  operationId: 'userIdentitiesAddAcsUserPost',
16901
16953
  requestBody: {
16902
16954
  content: {
16903
16955
  'application/json': {
16904
16956
  schema: {
16905
16957
  properties: {
16906
- acs_user_id: { format: 'uuid', type: 'string' },
16907
- 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
+ },
16908
16968
  },
16909
16969
  required: ['user_identity_id', 'acs_user_id'],
16910
16970
  type: 'object',
@@ -16938,16 +16998,26 @@ export default {
16938
16998
  'x-fern-sdk-group-name': ['user_identities'],
16939
16999
  'x-fern-sdk-method-name': 'add_acs_user',
16940
17000
  'x-response-key': null,
17001
+ 'x-title': 'Add an ACS User to a User Identity',
16941
17002
  },
16942
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).',
16943
17005
  operationId: 'userIdentitiesAddAcsUserPut',
16944
17006
  requestBody: {
16945
17007
  content: {
16946
17008
  'application/json': {
16947
17009
  schema: {
16948
17010
  properties: {
16949
- acs_user_id: { format: 'uuid', type: 'string' },
16950
- 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
+ },
16951
17021
  },
16952
17022
  required: ['user_identity_id', 'acs_user_id'],
16953
17023
  type: 'object',
@@ -16980,10 +17050,12 @@ export default {
16980
17050
  tags: ['/user_identities'],
16981
17051
  'x-fern-ignore': true,
16982
17052
  'x-response-key': null,
17053
+ 'x-title': 'Add an ACS User to a User Identity',
16983
17054
  },
16984
17055
  },
16985
17056
  '/user_identities/create': {
16986
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).',
16987
17059
  operationId: 'userIdentitiesCreatePost',
16988
17060
  requestBody: {
16989
17061
  content: {
@@ -16991,13 +17063,24 @@ export default {
16991
17063
  schema: {
16992
17064
  properties: {
16993
17065
  email_address: {
17066
+ description: 'Unique email address for the user identity.',
16994
17067
  format: 'email',
16995
17068
  nullable: true,
16996
17069
  type: 'string',
16997
17070
  },
16998
- full_name: { minLength: 1, nullable: true, type: 'string' },
16999
- 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
+ },
17000
17082
  user_identity_key: {
17083
+ description: 'Unique key for the user identity.',
17001
17084
  minLength: 1,
17002
17085
  nullable: true,
17003
17086
  type: 'string',
@@ -17040,17 +17123,23 @@ export default {
17040
17123
  'x-fern-sdk-method-name': 'create',
17041
17124
  'x-fern-sdk-return-value': 'user_identity',
17042
17125
  'x-response-key': 'user_identity',
17126
+ 'x-title': 'Create a User Identity',
17043
17127
  },
17044
17128
  },
17045
17129
  '/user_identities/delete': {
17046
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.',
17047
17132
  operationId: 'userIdentitiesDeletePost',
17048
17133
  requestBody: {
17049
17134
  content: {
17050
17135
  'application/json': {
17051
17136
  schema: {
17052
17137
  properties: {
17053
- 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
+ },
17054
17143
  },
17055
17144
  required: ['user_identity_id'],
17056
17145
  type: 'object',
@@ -17084,17 +17173,23 @@ export default {
17084
17173
  'x-fern-sdk-group-name': ['user_identities'],
17085
17174
  'x-fern-sdk-method-name': 'delete',
17086
17175
  'x-response-key': null,
17176
+ 'x-title': 'Delete a User Identity',
17087
17177
  },
17088
17178
  },
17089
17179
  '/user_identities/enrollment_automations/delete': {
17090
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).',
17091
17182
  operationId: 'userIdentitiesEnrollmentAutomationsDeletePost',
17092
17183
  requestBody: {
17093
17184
  content: {
17094
17185
  'application/json': {
17095
17186
  schema: {
17096
17187
  properties: {
17097
- 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
+ },
17098
17193
  },
17099
17194
  required: ['enrollment_automation_id'],
17100
17195
  type: 'object',
@@ -17128,17 +17223,23 @@ export default {
17128
17223
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
17129
17224
  'x-fern-sdk-method-name': 'delete',
17130
17225
  'x-response-key': null,
17226
+ 'x-title': 'Delete an Enrollment Automation',
17131
17227
  },
17132
17228
  },
17133
17229
  '/user_identities/enrollment_automations/get': {
17134
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).',
17135
17232
  operationId: 'userIdentitiesEnrollmentAutomationsGetPost',
17136
17233
  requestBody: {
17137
17234
  content: {
17138
17235
  'application/json': {
17139
17236
  schema: {
17140
17237
  properties: {
17141
- 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
+ },
17142
17243
  },
17143
17244
  required: ['enrollment_automation_id'],
17144
17245
  type: 'object',
@@ -17179,27 +17280,42 @@ export default {
17179
17280
  'x-fern-sdk-method-name': 'get',
17180
17281
  'x-fern-sdk-return-value': 'enrollment_automation',
17181
17282
  'x-response-key': 'enrollment_automation',
17283
+ 'x-title': 'Get an Enrollment Automation',
17182
17284
  },
17183
17285
  },
17184
17286
  '/user_identities/enrollment_automations/launch': {
17185
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).',
17186
17289
  operationId: 'userIdentitiesEnrollmentAutomationsLaunchPost',
17187
17290
  requestBody: {
17188
17291
  content: {
17189
17292
  'application/json': {
17190
17293
  schema: {
17191
17294
  properties: {
17192
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
17193
- 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
+ },
17194
17304
  credential_manager_acs_system_id: {
17305
+ description: 'ID of the desired ACS system that serves as the credential manager.',
17195
17306
  format: 'uuid',
17196
17307
  type: 'string',
17197
17308
  },
17198
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.',
17199
17316
  format: 'uuid',
17200
17317
  type: 'string',
17201
17318
  },
17202
- user_identity_id: { format: 'uuid', type: 'string' },
17203
17319
  },
17204
17320
  required: [
17205
17321
  'user_identity_id',
@@ -17267,17 +17383,23 @@ export default {
17267
17383
  'x-fern-sdk-method-name': 'launch',
17268
17384
  'x-fern-sdk-return-value': 'enrollment_automation',
17269
17385
  'x-response-key': 'enrollment_automation',
17386
+ 'x-title': 'Launch an Enrollment Automation',
17270
17387
  },
17271
17388
  },
17272
17389
  '/user_identities/enrollment_automations/list': {
17273
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).',
17274
17392
  operationId: 'userIdentitiesEnrollmentAutomationsListPost',
17275
17393
  requestBody: {
17276
17394
  content: {
17277
17395
  'application/json': {
17278
17396
  schema: {
17279
17397
  properties: {
17280
- 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
+ },
17281
17403
  },
17282
17404
  required: ['user_identity_id'],
17283
17405
  type: 'object',
@@ -17321,10 +17443,12 @@ export default {
17321
17443
  'x-fern-sdk-method-name': 'list',
17322
17444
  'x-fern-sdk-return-value': 'enrollment_automations',
17323
17445
  'x-response-key': 'enrollment_automations',
17446
+ 'x-title': 'List Enrollment Automations',
17324
17447
  },
17325
17448
  },
17326
17449
  '/user_identities/get': {
17327
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).',
17328
17452
  operationId: 'userIdentitiesGetPost',
17329
17453
  requestBody: {
17330
17454
  content: {
@@ -17333,7 +17457,11 @@ export default {
17333
17457
  oneOf: [
17334
17458
  {
17335
17459
  properties: {
17336
- 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
+ },
17337
17465
  },
17338
17466
  required: ['user_identity_id'],
17339
17467
  type: 'object',
@@ -17380,18 +17508,28 @@ export default {
17380
17508
  'x-fern-sdk-method-name': 'get',
17381
17509
  'x-fern-sdk-return-value': 'user_identity',
17382
17510
  'x-response-key': 'user_identity',
17511
+ 'x-title': 'Get a User Identity',
17383
17512
  },
17384
17513
  },
17385
17514
  '/user_identities/grant_access_to_device': {
17386
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/).',
17387
17517
  operationId: 'userIdentitiesGrantAccessToDevicePost',
17388
17518
  requestBody: {
17389
17519
  content: {
17390
17520
  'application/json': {
17391
17521
  schema: {
17392
17522
  properties: {
17393
- device_id: { format: 'uuid', type: 'string' },
17394
- 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
+ },
17395
17533
  },
17396
17534
  required: ['user_identity_id', 'device_id'],
17397
17535
  type: 'object',
@@ -17425,16 +17563,26 @@ export default {
17425
17563
  'x-fern-sdk-group-name': ['user_identities'],
17426
17564
  'x-fern-sdk-method-name': 'grant_access_to_device',
17427
17565
  'x-response-key': null,
17566
+ 'x-title': 'Grant a User Identity Access to a Device',
17428
17567
  },
17429
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/).',
17430
17570
  operationId: 'userIdentitiesGrantAccessToDevicePut',
17431
17571
  requestBody: {
17432
17572
  content: {
17433
17573
  'application/json': {
17434
17574
  schema: {
17435
17575
  properties: {
17436
- device_id: { format: 'uuid', type: 'string' },
17437
- 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
+ },
17438
17586
  },
17439
17587
  required: ['user_identity_id', 'device_id'],
17440
17588
  type: 'object',
@@ -17467,10 +17615,12 @@ export default {
17467
17615
  tags: ['/user_identities'],
17468
17616
  'x-fern-ignore': true,
17469
17617
  'x-response-key': null,
17618
+ 'x-title': 'Grant a User Identity Access to a Device',
17470
17619
  },
17471
17620
  },
17472
17621
  '/user_identities/list': {
17473
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).',
17474
17624
  operationId: 'userIdentitiesListPost',
17475
17625
  requestBody: {
17476
17626
  content: {
@@ -17521,17 +17671,23 @@ export default {
17521
17671
  'x-fern-sdk-method-name': 'list',
17522
17672
  'x-fern-sdk-return-value': 'user_identities',
17523
17673
  'x-response-key': 'user_identities',
17674
+ 'x-title': 'List User Identities',
17524
17675
  },
17525
17676
  },
17526
17677
  '/user_identities/list_accessible_devices': {
17527
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).',
17528
17680
  operationId: 'userIdentitiesListAccessibleDevicesPost',
17529
17681
  requestBody: {
17530
17682
  content: {
17531
17683
  'application/json': {
17532
17684
  schema: {
17533
17685
  properties: {
17534
- 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
+ },
17535
17691
  },
17536
17692
  required: ['user_identity_id'],
17537
17693
  type: 'object',
@@ -17578,17 +17734,23 @@ export default {
17578
17734
  'x-fern-sdk-method-name': 'list_accessible_devices',
17579
17735
  'x-fern-sdk-return-value': 'devices',
17580
17736
  'x-response-key': 'devices',
17737
+ 'x-title': 'List Accessible Devices for a User Identity',
17581
17738
  },
17582
17739
  },
17583
17740
  '/user_identities/list_acs_systems': {
17584
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).',
17585
17743
  operationId: 'userIdentitiesListAcsSystemsPost',
17586
17744
  requestBody: {
17587
17745
  content: {
17588
17746
  'application/json': {
17589
17747
  schema: {
17590
17748
  properties: {
17591
- 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
+ },
17592
17754
  },
17593
17755
  required: ['user_identity_id'],
17594
17756
  type: 'object',
@@ -17630,17 +17792,23 @@ export default {
17630
17792
  'x-fern-sdk-method-name': 'list_acs_systems',
17631
17793
  'x-fern-sdk-return-value': 'acs_systems',
17632
17794
  'x-response-key': 'acs_systems',
17795
+ 'x-title': 'List ACS Systems Associated with a User Identity',
17633
17796
  },
17634
17797
  },
17635
17798
  '/user_identities/list_acs_users': {
17636
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).',
17637
17801
  operationId: 'userIdentitiesListAcsUsersPost',
17638
17802
  requestBody: {
17639
17803
  content: {
17640
17804
  'application/json': {
17641
17805
  schema: {
17642
17806
  properties: {
17643
- 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
+ },
17644
17812
  },
17645
17813
  required: ['user_identity_id'],
17646
17814
  type: 'object',
@@ -17681,18 +17849,28 @@ export default {
17681
17849
  'x-fern-sdk-method-name': 'list_acs_users',
17682
17850
  'x-fern-sdk-return-value': 'acs_users',
17683
17851
  'x-response-key': 'acs_users',
17852
+ 'x-title': 'List ACS Users Associated with a User Identity',
17684
17853
  },
17685
17854
  },
17686
17855
  '/user_identities/remove_acs_user': {
17687
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).',
17688
17858
  operationId: 'userIdentitiesRemoveAcsUserPost',
17689
17859
  requestBody: {
17690
17860
  content: {
17691
17861
  'application/json': {
17692
17862
  schema: {
17693
17863
  properties: {
17694
- acs_user_id: { format: 'uuid', type: 'string' },
17695
- 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
+ },
17696
17874
  },
17697
17875
  required: ['user_identity_id', 'acs_user_id'],
17698
17876
  type: 'object',
@@ -17726,18 +17904,28 @@ export default {
17726
17904
  'x-fern-sdk-group-name': ['user_identities'],
17727
17905
  'x-fern-sdk-method-name': 'remove_acs_user',
17728
17906
  'x-response-key': null,
17907
+ 'x-title': 'Remove an ACS User from a User Identity',
17729
17908
  },
17730
17909
  },
17731
17910
  '/user_identities/revoke_access_to_device': {
17732
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).',
17733
17913
  operationId: 'userIdentitiesRevokeAccessToDevicePost',
17734
17914
  requestBody: {
17735
17915
  content: {
17736
17916
  'application/json': {
17737
17917
  schema: {
17738
17918
  properties: {
17739
- device_id: { format: 'uuid', type: 'string' },
17740
- 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
+ },
17741
17929
  },
17742
17930
  required: ['user_identity_id', 'device_id'],
17743
17931
  type: 'object',
@@ -17771,6 +17959,7 @@ export default {
17771
17959
  'x-fern-sdk-group-name': ['user_identities'],
17772
17960
  'x-fern-sdk-method-name': 'revoke_access_to_device',
17773
17961
  'x-response-key': null,
17962
+ 'x-title': 'Revoke Access to a Device from a User Identity',
17774
17963
  },
17775
17964
  },
17776
17965
  '/user_identities/update': {
@@ -17782,14 +17971,24 @@ export default {
17782
17971
  schema: {
17783
17972
  properties: {
17784
17973
  email_address: {
17974
+ description: 'Unique email address for the user identity.',
17785
17975
  format: 'email',
17786
17976
  nullable: true,
17787
17977
  type: 'string',
17788
17978
  },
17789
17979
  full_name: { minLength: 1, nullable: true, type: 'string' },
17790
- phone_number: { nullable: true, type: 'string' },
17791
- 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
+ },
17792
17990
  user_identity_key: {
17991
+ description: 'Unique key for the user identity.',
17793
17992
  minLength: 1,
17794
17993
  nullable: true,
17795
17994
  type: 'string',
@@ -17835,14 +18034,24 @@ export default {
17835
18034
  schema: {
17836
18035
  properties: {
17837
18036
  email_address: {
18037
+ description: 'Unique email address for the user identity.',
17838
18038
  format: 'email',
17839
18039
  nullable: true,
17840
18040
  type: 'string',
17841
18041
  },
17842
18042
  full_name: { minLength: 1, nullable: true, type: 'string' },
17843
- phone_number: { nullable: true, type: 'string' },
17844
- 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
+ },
17845
18053
  user_identity_key: {
18054
+ description: 'Unique key for the user identity.',
17846
18055
  minLength: 1,
17847
18056
  nullable: true,
17848
18057
  type: 'string',