@seamapi/types 1.916.0 → 1.917.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 (56) hide show
  1. package/dist/connect.cjs +603 -160
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +872 -15
  4. package/dist/index.cjs +603 -160
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.js +4 -2
  7. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-credential.js +12 -3
  9. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-system.js +15 -5
  11. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-users/acs-user.js +8 -2
  13. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/connect-webviews/connect-webview.js +1 -1
  15. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device-provider.js +8 -4
  17. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device.js +60 -20
  19. package/lib/seam/connect/models/devices/device.js.map +1 -1
  20. package/lib/seam/connect/models/devices/phone.js +10 -6
  21. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  22. package/lib/seam/connect/models/devices/unmanaged-device.js +3 -1
  23. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  24. package/lib/seam/connect/models/events/access-codes.js +7 -3
  25. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  26. package/lib/seam/connect/models/events/acs/entrances.js +3 -5
  27. package/lib/seam/connect/models/events/acs/entrances.js.map +1 -1
  28. package/lib/seam/connect/models/events/acs/users.js +6 -5
  29. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  30. package/lib/seam/connect/models/events/common.js +8 -4
  31. package/lib/seam/connect/models/events/common.js.map +1 -1
  32. package/lib/seam/connect/models/thermostats/modes.js +9 -16
  33. package/lib/seam/connect/models/thermostats/modes.js.map +1 -1
  34. package/lib/seam/connect/models/user-identities/user-identity.js +9 -2
  35. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  36. package/lib/seam/connect/openapi.js +494 -96
  37. package/lib/seam/connect/openapi.js.map +1 -1
  38. package/lib/seam/connect/route-types.d.ts +872 -15
  39. package/package.json +1 -1
  40. package/src/lib/seam/connect/models/acs/acs-access-group.ts +4 -2
  41. package/src/lib/seam/connect/models/acs/acs-credential.ts +14 -3
  42. package/src/lib/seam/connect/models/acs/acs-system.ts +25 -5
  43. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +10 -2
  44. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +3 -1
  45. package/src/lib/seam/connect/models/devices/device-provider.ts +10 -4
  46. package/src/lib/seam/connect/models/devices/device.ts +90 -20
  47. package/src/lib/seam/connect/models/devices/phone.ts +12 -6
  48. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +3 -1
  49. package/src/lib/seam/connect/models/events/access-codes.ts +18 -14
  50. package/src/lib/seam/connect/models/events/acs/entrances.ts +3 -5
  51. package/src/lib/seam/connect/models/events/acs/users.ts +6 -5
  52. package/src/lib/seam/connect/models/events/common.ts +32 -24
  53. package/src/lib/seam/connect/models/thermostats/modes.ts +15 -16
  54. package/src/lib/seam/connect/models/user-identities/user-identity.ts +9 -2
  55. package/src/lib/seam/connect/openapi.ts +641 -96
  56. package/src/lib/seam/connect/route-types.ts +872 -15
@@ -2924,7 +2924,10 @@ const openapi: OpenAPISpec = {
2924
2924
  format: 'date-time',
2925
2925
  type: 'string',
2926
2926
  },
2927
- display_name: { type: 'string' },
2927
+ display_name: {
2928
+ description: 'Display name for the access group.',
2929
+ type: 'string',
2930
+ },
2928
2931
  errors: {
2929
2932
  description: 'Errors associated with the `acs_access_group`.',
2930
2933
  items: {
@@ -2980,7 +2983,11 @@ const openapi: OpenAPISpec = {
2980
2983
  'Display name that corresponds to the brand-specific terminology for the access group type.',
2981
2984
  type: 'string',
2982
2985
  },
2983
- is_managed: { enum: [true], type: 'boolean' },
2986
+ is_managed: {
2987
+ description: 'Indicates whether Seam manages the access group.',
2988
+ enum: [true],
2989
+ type: 'boolean',
2990
+ },
2984
2991
  name: { description: 'Name of the access group.', type: 'string' },
2985
2992
  pending_mutations: {
2986
2993
  description:
@@ -3439,7 +3446,12 @@ const openapi: OpenAPISpec = {
3439
3446
  format: 'uuid',
3440
3447
  type: 'string',
3441
3448
  },
3442
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
3449
+ acs_credential_pool_id: {
3450
+ description:
3451
+ 'ID of the credential pool to which the credential belongs.',
3452
+ format: 'uuid',
3453
+ type: 'string',
3454
+ },
3443
3455
  acs_system_id: {
3444
3456
  description:
3445
3457
  'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -3572,7 +3584,11 @@ const openapi: OpenAPISpec = {
3572
3584
  nullable: true,
3573
3585
  type: 'boolean',
3574
3586
  },
3575
- is_managed: { enum: [true], type: 'boolean' },
3587
+ is_managed: {
3588
+ description: 'Indicates whether Seam manages the credential.',
3589
+ enum: [true],
3590
+ type: 'boolean',
3591
+ },
3576
3592
  is_multi_phone_sync_credential: {
3577
3593
  description:
3578
3594
  'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
@@ -4508,14 +4524,24 @@ const openapi: OpenAPISpec = {
4508
4524
  description:
4509
4525
  'Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).',
4510
4526
  properties: {
4511
- acs_access_group_count: { format: 'float', type: 'number' },
4527
+ acs_access_group_count: {
4528
+ description:
4529
+ 'Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
4530
+ format: 'float',
4531
+ type: 'number',
4532
+ },
4512
4533
  acs_system_id: {
4513
4534
  description:
4514
4535
  'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
4515
4536
  format: 'uuid',
4516
4537
  type: 'string',
4517
4538
  },
4518
- acs_user_count: { format: 'float', type: 'number' },
4539
+ acs_user_count: {
4540
+ description:
4541
+ 'Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
4542
+ format: 'float',
4543
+ type: 'number',
4544
+ },
4519
4545
  connected_account_id: {
4520
4546
  description:
4521
4547
  'ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
@@ -4592,7 +4618,11 @@ const openapi: OpenAPISpec = {
4592
4618
  enum: ['bridge_disconnected'],
4593
4619
  type: 'string',
4594
4620
  },
4595
- is_bridge_error: { type: 'boolean' },
4621
+ is_bridge_error: {
4622
+ description:
4623
+ 'Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
4624
+ type: 'boolean',
4625
+ },
4596
4626
  message: {
4597
4627
  description:
4598
4628
  'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
@@ -4799,6 +4829,8 @@ const openapi: OpenAPISpec = {
4799
4829
  type: 'boolean',
4800
4830
  },
4801
4831
  location: {
4832
+ description:
4833
+ 'Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
4802
4834
  properties: {
4803
4835
  time_zone: {
4804
4836
  description:
@@ -4843,6 +4875,8 @@ const openapi: OpenAPISpec = {
4843
4875
  'x-deprecated': 'Use `external_type_display_name`.',
4844
4876
  },
4845
4877
  visionline_metadata: {
4878
+ description:
4879
+ 'Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
4846
4880
  properties: {
4847
4881
  lan_address: {
4848
4882
  description:
@@ -5222,8 +5256,18 @@ const openapi: OpenAPISpec = {
5222
5256
  minLength: 1,
5223
5257
  type: 'string',
5224
5258
  },
5225
- hid_acs_system_id: { format: 'uuid', type: 'string' },
5226
- is_managed: { enum: [true], type: 'boolean' },
5259
+ hid_acs_system_id: {
5260
+ description:
5261
+ 'ID of the HID access control system associated with the user.',
5262
+ format: 'uuid',
5263
+ type: 'string',
5264
+ },
5265
+ is_managed: {
5266
+ description:
5267
+ 'Indicates whether Seam manages the access system user.',
5268
+ enum: [true],
5269
+ type: 'boolean',
5270
+ },
5227
5271
  is_suspended: {
5228
5272
  description:
5229
5273
  'Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).',
@@ -6160,7 +6204,12 @@ const openapi: OpenAPISpec = {
6160
6204
  nullable: true,
6161
6205
  type: 'string',
6162
6206
  },
6163
- is_issued: { nullable: true, type: 'boolean' },
6207
+ is_issued: {
6208
+ description:
6209
+ 'Indicates whether the credential has been issued (encoded onto a card).',
6210
+ nullable: true,
6211
+ type: 'boolean',
6212
+ },
6164
6213
  starts_at: {
6165
6214
  description:
6166
6215
  'Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable.',
@@ -6281,6 +6330,8 @@ const openapi: OpenAPISpec = {
6281
6330
  type: 'string',
6282
6331
  },
6283
6332
  acs_credential_pool_id: {
6333
+ description:
6334
+ 'ID of the credential pool to which the credential belongs.',
6284
6335
  format: 'uuid',
6285
6336
  type: 'string',
6286
6337
  },
@@ -6418,7 +6469,12 @@ const openapi: OpenAPISpec = {
6418
6469
  nullable: true,
6419
6470
  type: 'boolean',
6420
6471
  },
6421
- is_managed: { enum: [true], type: 'boolean' },
6472
+ is_managed: {
6473
+ description:
6474
+ 'Indicates whether Seam manages the credential.',
6475
+ enum: [true],
6476
+ type: 'boolean',
6477
+ },
6422
6478
  is_multi_phone_sync_credential: {
6423
6479
  description:
6424
6480
  'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
@@ -6739,6 +6795,8 @@ const openapi: OpenAPISpec = {
6739
6795
  type: 'string',
6740
6796
  },
6741
6797
  acs_credential_pool_id: {
6798
+ description:
6799
+ 'ID of the credential pool to which the credential belongs.',
6742
6800
  format: 'uuid',
6743
6801
  type: 'string',
6744
6802
  },
@@ -7454,6 +7512,8 @@ const openapi: OpenAPISpec = {
7454
7512
  type: 'string',
7455
7513
  },
7456
7514
  acs_credential_pool_id: {
7515
+ description:
7516
+ 'ID of the credential pool to which the credential belongs.',
7457
7517
  format: 'uuid',
7458
7518
  type: 'string',
7459
7519
  },
@@ -7590,7 +7650,12 @@ const openapi: OpenAPISpec = {
7590
7650
  nullable: true,
7591
7651
  type: 'boolean',
7592
7652
  },
7593
- is_managed: { enum: [true], type: 'boolean' },
7653
+ is_managed: {
7654
+ description:
7655
+ 'Indicates whether Seam manages the credential.',
7656
+ enum: [true],
7657
+ type: 'boolean',
7658
+ },
7594
7659
  is_multi_phone_sync_credential: {
7595
7660
  description:
7596
7661
  'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
@@ -7909,6 +7974,8 @@ const openapi: OpenAPISpec = {
7909
7974
  type: 'string',
7910
7975
  },
7911
7976
  acs_credential_pool_id: {
7977
+ description:
7978
+ 'ID of the credential pool to which the credential belongs.',
7912
7979
  format: 'uuid',
7913
7980
  type: 'string',
7914
7981
  },
@@ -8657,7 +8724,12 @@ const openapi: OpenAPISpec = {
8657
8724
  format: 'uuid',
8658
8725
  type: 'string',
8659
8726
  },
8660
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
8727
+ acs_credential_pool_id: {
8728
+ description:
8729
+ 'ID of the credential pool to which the credential belongs.',
8730
+ format: 'uuid',
8731
+ type: 'string',
8732
+ },
8661
8733
  acs_system_id: {
8662
8734
  description:
8663
8735
  'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -8790,7 +8862,12 @@ const openapi: OpenAPISpec = {
8790
8862
  nullable: true,
8791
8863
  type: 'boolean',
8792
8864
  },
8793
- is_managed: { enum: [true], type: 'boolean' },
8865
+ is_managed: {
8866
+ description:
8867
+ 'Indicates whether Seam manages the credential.',
8868
+ enum: [true],
8869
+ type: 'boolean',
8870
+ },
8794
8871
  is_multi_phone_sync_credential: {
8795
8872
  description:
8796
8873
  'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
@@ -11948,6 +12025,8 @@ const openapi: OpenAPISpec = {
11948
12025
  type: 'string',
11949
12026
  },
11950
12027
  device_selection_mode: {
12028
+ description:
12029
+ 'Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.',
11951
12030
  enum: ['none', 'single', 'multiple'],
11952
12031
  type: 'string',
11953
12032
  },
@@ -12725,30 +12804,103 @@ const openapi: OpenAPISpec = {
12725
12804
  description:
12726
12805
  'Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.',
12727
12806
  properties: {
12728
- can_configure_auto_lock: { type: 'boolean' },
12729
- can_hvac_cool: { type: 'boolean' },
12730
- can_hvac_heat: { type: 'boolean' },
12731
- can_hvac_heat_cool: { type: 'boolean' },
12732
- can_program_offline_access_codes: { type: 'boolean' },
12733
- can_program_online_access_codes: { type: 'boolean' },
12807
+ can_configure_auto_lock: {
12808
+ description:
12809
+ 'Indicates whether the lock supports configuring automatic locking.',
12810
+ type: 'boolean',
12811
+ },
12812
+ can_hvac_cool: {
12813
+ description: 'Indicates whether the thermostat supports cooling.',
12814
+ type: 'boolean',
12815
+ },
12816
+ can_hvac_heat: {
12817
+ description: 'Indicates whether the thermostat supports heating.',
12818
+ type: 'boolean',
12819
+ },
12820
+ can_hvac_heat_cool: {
12821
+ description:
12822
+ 'Indicates whether the thermostat supports simultaneous heating and cooling.',
12823
+ type: 'boolean',
12824
+ },
12825
+ can_program_offline_access_codes: {
12826
+ description:
12827
+ 'Indicates whether the device supports programming offline access codes.',
12828
+ type: 'boolean',
12829
+ },
12830
+ can_program_online_access_codes: {
12831
+ description:
12832
+ 'Indicates whether the device supports programming online access codes.',
12833
+ type: 'boolean',
12834
+ },
12734
12835
  can_program_thermostat_programs_as_different_each_day: {
12836
+ description:
12837
+ 'Indicates whether the thermostat supports different climate programs for each day of the week.',
12838
+ type: 'boolean',
12839
+ },
12840
+ can_program_thermostat_programs_as_same_each_day: {
12841
+ description:
12842
+ 'Indicates whether the thermostat supports a single climate program applied to every day.',
12735
12843
  type: 'boolean',
12736
12844
  },
12737
- can_program_thermostat_programs_as_same_each_day: { type: 'boolean' },
12738
12845
  can_program_thermostat_programs_as_weekday_weekend: {
12846
+ description:
12847
+ 'Indicates whether the thermostat supports weekday/weekend climate programs.',
12848
+ type: 'boolean',
12849
+ },
12850
+ can_remotely_lock: {
12851
+ description:
12852
+ 'Indicates whether the device supports remote locking.',
12853
+ type: 'boolean',
12854
+ },
12855
+ can_remotely_unlock: {
12856
+ description:
12857
+ 'Indicates whether the device supports remote unlocking.',
12858
+ type: 'boolean',
12859
+ },
12860
+ can_run_thermostat_programs: {
12861
+ description:
12862
+ 'Indicates whether the thermostat supports running climate programs.',
12863
+ type: 'boolean',
12864
+ },
12865
+ can_simulate_connection: {
12866
+ description:
12867
+ 'Indicates whether the device supports simulating connection in a sandbox.',
12868
+ type: 'boolean',
12869
+ },
12870
+ can_simulate_disconnection: {
12871
+ description:
12872
+ 'Indicates whether the device supports simulating disconnection in a sandbox.',
12873
+ type: 'boolean',
12874
+ },
12875
+ can_simulate_hub_connection: {
12876
+ description:
12877
+ 'Indicates whether the hub supports simulating connection in a sandbox.',
12878
+ type: 'boolean',
12879
+ },
12880
+ can_simulate_hub_disconnection: {
12881
+ description:
12882
+ 'Indicates whether the hub supports simulating disconnection in a sandbox.',
12883
+ type: 'boolean',
12884
+ },
12885
+ can_simulate_paid_subscription: {
12886
+ description:
12887
+ 'Indicates whether the device supports simulating a paid subscription in a sandbox.',
12888
+ type: 'boolean',
12889
+ },
12890
+ can_simulate_removal: {
12891
+ description:
12892
+ 'Indicates whether the device supports simulating removal in a sandbox.',
12893
+ type: 'boolean',
12894
+ },
12895
+ can_turn_off_hvac: {
12896
+ description: 'Indicates whether the thermostat can be turned off.',
12897
+ type: 'boolean',
12898
+ },
12899
+ can_unlock_with_code: {
12900
+ description:
12901
+ 'Indicates whether the lock supports unlocking with an access code.',
12739
12902
  type: 'boolean',
12740
12903
  },
12741
- can_remotely_lock: { type: 'boolean' },
12742
- can_remotely_unlock: { type: 'boolean' },
12743
- can_run_thermostat_programs: { type: 'boolean' },
12744
- can_simulate_connection: { type: 'boolean' },
12745
- can_simulate_disconnection: { type: 'boolean' },
12746
- can_simulate_hub_connection: { type: 'boolean' },
12747
- can_simulate_hub_disconnection: { type: 'boolean' },
12748
- can_simulate_paid_subscription: { type: 'boolean' },
12749
- can_simulate_removal: { type: 'boolean' },
12750
- can_turn_off_hvac: { type: 'boolean' },
12751
- can_unlock_with_code: { type: 'boolean' },
12752
12904
  capabilities_supported: {
12753
12905
  description:
12754
12906
  '\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ',
@@ -15482,6 +15634,8 @@ const openapi: OpenAPISpec = {
15482
15634
  description:
15483
15635
  'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
15484
15636
  items: {
15637
+ description:
15638
+ 'Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.',
15485
15639
  enum: [
15486
15640
  'home',
15487
15641
  'away',
@@ -15636,6 +15790,8 @@ const openapi: OpenAPISpec = {
15636
15790
  description:
15637
15791
  'Fan mode settings that the thermostat supports.',
15638
15792
  items: {
15793
+ description:
15794
+ 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.',
15639
15795
  enum: ['auto', 'on', 'circulate'],
15640
15796
  type: 'string',
15641
15797
  },
@@ -15646,6 +15802,8 @@ const openapi: OpenAPISpec = {
15646
15802
  description:
15647
15803
  'HVAC mode settings that the thermostat supports.',
15648
15804
  items: {
15805
+ description:
15806
+ 'HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.',
15649
15807
  enum: ['off', 'heat', 'cool', 'heat_cool', 'eco'],
15650
15808
  type: 'string',
15651
15809
  },
@@ -17005,31 +17163,105 @@ const openapi: OpenAPISpec = {
17005
17163
  },
17006
17164
  device_provider: {
17007
17165
  properties: {
17008
- can_configure_auto_lock: { type: 'boolean' },
17009
- can_hvac_cool: { type: 'boolean' },
17010
- can_hvac_heat: { type: 'boolean' },
17011
- can_hvac_heat_cool: { type: 'boolean' },
17012
- can_program_offline_access_codes: { type: 'boolean' },
17013
- can_program_online_access_codes: { type: 'boolean' },
17166
+ can_configure_auto_lock: {
17167
+ description:
17168
+ 'Indicates whether the lock supports configuring automatic locking.',
17169
+ type: 'boolean',
17170
+ },
17171
+ can_hvac_cool: {
17172
+ description: 'Indicates whether the thermostat supports cooling.',
17173
+ type: 'boolean',
17174
+ },
17175
+ can_hvac_heat: {
17176
+ description: 'Indicates whether the thermostat supports heating.',
17177
+ type: 'boolean',
17178
+ },
17179
+ can_hvac_heat_cool: {
17180
+ description:
17181
+ 'Indicates whether the thermostat supports simultaneous heating and cooling.',
17182
+ type: 'boolean',
17183
+ },
17184
+ can_program_offline_access_codes: {
17185
+ description:
17186
+ 'Indicates whether the device supports programming offline access codes.',
17187
+ type: 'boolean',
17188
+ },
17189
+ can_program_online_access_codes: {
17190
+ description:
17191
+ 'Indicates whether the device supports programming online access codes.',
17192
+ type: 'boolean',
17193
+ },
17014
17194
  can_program_thermostat_programs_as_different_each_day: {
17195
+ description:
17196
+ 'Indicates whether the thermostat supports different climate programs for each day of the week.',
17197
+ type: 'boolean',
17198
+ },
17199
+ can_program_thermostat_programs_as_same_each_day: {
17200
+ description:
17201
+ 'Indicates whether the thermostat supports a single climate program applied to every day.',
17015
17202
  type: 'boolean',
17016
17203
  },
17017
- can_program_thermostat_programs_as_same_each_day: { type: 'boolean' },
17018
17204
  can_program_thermostat_programs_as_weekday_weekend: {
17205
+ description:
17206
+ 'Indicates whether the thermostat supports weekday/weekend climate programs.',
17207
+ type: 'boolean',
17208
+ },
17209
+ can_remotely_lock: {
17210
+ description:
17211
+ 'Indicates whether the device supports remote locking.',
17212
+ type: 'boolean',
17213
+ },
17214
+ can_remotely_unlock: {
17215
+ description:
17216
+ 'Indicates whether the device supports remote unlocking.',
17217
+ type: 'boolean',
17218
+ },
17219
+ can_run_thermostat_programs: {
17220
+ description:
17221
+ 'Indicates whether the thermostat supports running climate programs.',
17222
+ type: 'boolean',
17223
+ },
17224
+ can_simulate_connection: {
17225
+ description:
17226
+ 'Indicates whether the device supports simulating connection in a sandbox.',
17227
+ type: 'boolean',
17228
+ },
17229
+ can_simulate_disconnection: {
17230
+ description:
17231
+ 'Indicates whether the device supports simulating disconnection in a sandbox.',
17232
+ type: 'boolean',
17233
+ },
17234
+ can_simulate_hub_connection: {
17235
+ description:
17236
+ 'Indicates whether the hub supports simulating connection in a sandbox.',
17237
+ type: 'boolean',
17238
+ },
17239
+ can_simulate_hub_disconnection: {
17240
+ description:
17241
+ 'Indicates whether the hub supports simulating disconnection in a sandbox.',
17242
+ type: 'boolean',
17243
+ },
17244
+ can_simulate_paid_subscription: {
17245
+ description:
17246
+ 'Indicates whether the device supports simulating a paid subscription in a sandbox.',
17247
+ type: 'boolean',
17248
+ },
17249
+ can_simulate_removal: {
17250
+ description:
17251
+ 'Indicates whether the device supports simulating removal in a sandbox.',
17252
+ type: 'boolean',
17253
+ },
17254
+ can_turn_off_hvac: {
17255
+ description: 'Indicates whether the thermostat can be turned off.',
17256
+ type: 'boolean',
17257
+ },
17258
+ can_unlock_with_code: {
17259
+ description:
17260
+ 'Indicates whether the lock supports unlocking with an access code.',
17019
17261
  type: 'boolean',
17020
17262
  },
17021
- can_remotely_lock: { type: 'boolean' },
17022
- can_remotely_unlock: { type: 'boolean' },
17023
- can_run_thermostat_programs: { type: 'boolean' },
17024
- can_simulate_connection: { type: 'boolean' },
17025
- can_simulate_disconnection: { type: 'boolean' },
17026
- can_simulate_hub_connection: { type: 'boolean' },
17027
- can_simulate_hub_disconnection: { type: 'boolean' },
17028
- can_simulate_paid_subscription: { type: 'boolean' },
17029
- can_simulate_removal: { type: 'boolean' },
17030
- can_turn_off_hvac: { type: 'boolean' },
17031
- can_unlock_with_code: { type: 'boolean' },
17032
17263
  device_provider_name: {
17264
+ description: 'Name of the device provider.',
17033
17265
  enum: [
17034
17266
  'hotek',
17035
17267
  'dormakaba_community',
@@ -17094,9 +17326,17 @@ const openapi: OpenAPISpec = {
17094
17326
  ],
17095
17327
  type: 'string',
17096
17328
  },
17097
- display_name: { type: 'string' },
17098
- image_url: { type: 'string' },
17329
+ display_name: {
17330
+ description: 'Display name for the device provider.',
17331
+ type: 'string',
17332
+ },
17333
+ image_url: {
17334
+ description: 'Image URL for the device provider.',
17335
+ type: 'string',
17336
+ },
17099
17337
  provider_categories: {
17338
+ description:
17339
+ 'List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.',
17100
17340
  items: {
17101
17341
  enum: [
17102
17342
  'stable',
@@ -17262,6 +17502,7 @@ const openapi: OpenAPISpec = {
17262
17502
  description:
17263
17503
  'List of properties that changed on the access code.',
17264
17504
  items: {
17505
+ description: 'Record describing a single changed property.',
17265
17506
  properties: {
17266
17507
  from: {
17267
17508
  description:
@@ -17922,6 +18163,8 @@ const openapi: OpenAPISpec = {
17922
18163
  access_code_errors: {
17923
18164
  description: 'Errors associated with the access code.',
17924
18165
  items: {
18166
+ description:
18167
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
17925
18168
  properties: {
17926
18169
  created_at: {
17927
18170
  description:
@@ -17953,6 +18196,8 @@ const openapi: OpenAPISpec = {
17953
18196
  access_code_warnings: {
17954
18197
  description: 'Warnings associated with the access code.',
17955
18198
  items: {
18199
+ description:
18200
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
17956
18201
  properties: {
17957
18202
  created_at: {
17958
18203
  description:
@@ -17987,6 +18232,8 @@ const openapi: OpenAPISpec = {
17987
18232
  connected_account_errors: {
17988
18233
  description: 'Errors associated with the connected account.',
17989
18234
  items: {
18235
+ description:
18236
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
17990
18237
  properties: {
17991
18238
  created_at: {
17992
18239
  description:
@@ -18019,6 +18266,8 @@ const openapi: OpenAPISpec = {
18019
18266
  connected_account_warnings: {
18020
18267
  description: 'Warnings associated with the connected account.',
18021
18268
  items: {
18269
+ description:
18270
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18022
18271
  properties: {
18023
18272
  created_at: {
18024
18273
  description:
@@ -18058,6 +18307,8 @@ const openapi: OpenAPISpec = {
18058
18307
  device_errors: {
18059
18308
  description: 'Errors associated with the device.',
18060
18309
  items: {
18310
+ description:
18311
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18061
18312
  properties: {
18062
18313
  created_at: {
18063
18314
  description:
@@ -18090,6 +18341,8 @@ const openapi: OpenAPISpec = {
18090
18341
  device_warnings: {
18091
18342
  description: 'Warnings associated with the device.',
18092
18343
  items: {
18344
+ description:
18345
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18093
18346
  properties: {
18094
18347
  created_at: {
18095
18348
  description:
@@ -18159,6 +18412,8 @@ const openapi: OpenAPISpec = {
18159
18412
  access_code_errors: {
18160
18413
  description: 'Errors associated with the access code.',
18161
18414
  items: {
18415
+ description:
18416
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18162
18417
  properties: {
18163
18418
  created_at: {
18164
18419
  description:
@@ -18190,6 +18445,8 @@ const openapi: OpenAPISpec = {
18190
18445
  access_code_warnings: {
18191
18446
  description: 'Warnings associated with the access code.',
18192
18447
  items: {
18448
+ description:
18449
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18193
18450
  properties: {
18194
18451
  created_at: {
18195
18452
  description:
@@ -18224,6 +18481,8 @@ const openapi: OpenAPISpec = {
18224
18481
  connected_account_errors: {
18225
18482
  description: 'Errors associated with the connected account.',
18226
18483
  items: {
18484
+ description:
18485
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18227
18486
  properties: {
18228
18487
  created_at: {
18229
18488
  description:
@@ -18256,6 +18515,8 @@ const openapi: OpenAPISpec = {
18256
18515
  connected_account_warnings: {
18257
18516
  description: 'Warnings associated with the connected account.',
18258
18517
  items: {
18518
+ description:
18519
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18259
18520
  properties: {
18260
18521
  created_at: {
18261
18522
  description:
@@ -18295,6 +18556,8 @@ const openapi: OpenAPISpec = {
18295
18556
  device_errors: {
18296
18557
  description: 'Errors associated with the device.',
18297
18558
  items: {
18559
+ description:
18560
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18298
18561
  properties: {
18299
18562
  created_at: {
18300
18563
  description:
@@ -18327,6 +18590,8 @@ const openapi: OpenAPISpec = {
18327
18590
  device_warnings: {
18328
18591
  description: 'Warnings associated with the device.',
18329
18592
  items: {
18593
+ description:
18594
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18330
18595
  properties: {
18331
18596
  created_at: {
18332
18597
  description:
@@ -18474,6 +18739,8 @@ const openapi: OpenAPISpec = {
18474
18739
  access_code_errors: {
18475
18740
  description: 'Errors associated with the access code.',
18476
18741
  items: {
18742
+ description:
18743
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18477
18744
  properties: {
18478
18745
  created_at: {
18479
18746
  description:
@@ -18505,6 +18772,8 @@ const openapi: OpenAPISpec = {
18505
18772
  access_code_warnings: {
18506
18773
  description: 'Warnings associated with the access code.',
18507
18774
  items: {
18775
+ description:
18776
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18508
18777
  properties: {
18509
18778
  created_at: {
18510
18779
  description:
@@ -18539,6 +18808,8 @@ const openapi: OpenAPISpec = {
18539
18808
  connected_account_errors: {
18540
18809
  description: 'Errors associated with the connected account.',
18541
18810
  items: {
18811
+ description:
18812
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18542
18813
  properties: {
18543
18814
  created_at: {
18544
18815
  description:
@@ -18571,6 +18842,8 @@ const openapi: OpenAPISpec = {
18571
18842
  connected_account_warnings: {
18572
18843
  description: 'Warnings associated with the connected account.',
18573
18844
  items: {
18845
+ description:
18846
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18574
18847
  properties: {
18575
18848
  created_at: {
18576
18849
  description:
@@ -18610,6 +18883,8 @@ const openapi: OpenAPISpec = {
18610
18883
  device_errors: {
18611
18884
  description: 'Errors associated with the device.',
18612
18885
  items: {
18886
+ description:
18887
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18613
18888
  properties: {
18614
18889
  created_at: {
18615
18890
  description:
@@ -18642,6 +18917,8 @@ const openapi: OpenAPISpec = {
18642
18917
  device_warnings: {
18643
18918
  description: 'Warnings associated with the device.',
18644
18919
  items: {
18920
+ description:
18921
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18645
18922
  properties: {
18646
18923
  created_at: {
18647
18924
  description:
@@ -18711,6 +18988,8 @@ const openapi: OpenAPISpec = {
18711
18988
  access_code_errors: {
18712
18989
  description: 'Errors associated with the access code.',
18713
18990
  items: {
18991
+ description:
18992
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18714
18993
  properties: {
18715
18994
  created_at: {
18716
18995
  description:
@@ -18742,6 +19021,8 @@ const openapi: OpenAPISpec = {
18742
19021
  access_code_warnings: {
18743
19022
  description: 'Warnings associated with the access code.',
18744
19023
  items: {
19024
+ description:
19025
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18745
19026
  properties: {
18746
19027
  created_at: {
18747
19028
  description:
@@ -18776,6 +19057,8 @@ const openapi: OpenAPISpec = {
18776
19057
  connected_account_errors: {
18777
19058
  description: 'Errors associated with the connected account.',
18778
19059
  items: {
19060
+ description:
19061
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18779
19062
  properties: {
18780
19063
  created_at: {
18781
19064
  description:
@@ -18808,6 +19091,8 @@ const openapi: OpenAPISpec = {
18808
19091
  connected_account_warnings: {
18809
19092
  description: 'Warnings associated with the connected account.',
18810
19093
  items: {
19094
+ description:
19095
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18811
19096
  properties: {
18812
19097
  created_at: {
18813
19098
  description:
@@ -18847,6 +19132,8 @@ const openapi: OpenAPISpec = {
18847
19132
  device_errors: {
18848
19133
  description: 'Errors associated with the device.',
18849
19134
  items: {
19135
+ description:
19136
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
18850
19137
  properties: {
18851
19138
  created_at: {
18852
19139
  description:
@@ -18879,6 +19166,8 @@ const openapi: OpenAPISpec = {
18879
19166
  device_warnings: {
18880
19167
  description: 'Warnings associated with the device.',
18881
19168
  items: {
19169
+ description:
19170
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
18882
19171
  properties: {
18883
19172
  created_at: {
18884
19173
  description:
@@ -19100,7 +19389,11 @@ const openapi: OpenAPISpec = {
19100
19389
  format: 'uuid',
19101
19390
  type: 'string',
19102
19391
  },
19103
- backup_access_code_id: { type: 'string' },
19392
+ backup_access_code_id: {
19393
+ description:
19394
+ 'ID of the backup access code that was pulled from the pool.',
19395
+ type: 'string',
19396
+ },
19104
19397
  connected_account_custom_metadata: {
19105
19398
  additionalProperties: {
19106
19399
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
@@ -19250,6 +19543,8 @@ const openapi: OpenAPISpec = {
19250
19543
  access_code_errors: {
19251
19544
  description: 'Errors associated with the access code.',
19252
19545
  items: {
19546
+ description:
19547
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19253
19548
  properties: {
19254
19549
  created_at: {
19255
19550
  description:
@@ -19281,6 +19576,8 @@ const openapi: OpenAPISpec = {
19281
19576
  access_code_warnings: {
19282
19577
  description: 'Warnings associated with the access code.',
19283
19578
  items: {
19579
+ description:
19580
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19284
19581
  properties: {
19285
19582
  created_at: {
19286
19583
  description:
@@ -19315,6 +19612,8 @@ const openapi: OpenAPISpec = {
19315
19612
  connected_account_errors: {
19316
19613
  description: 'Errors associated with the connected account.',
19317
19614
  items: {
19615
+ description:
19616
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19318
19617
  properties: {
19319
19618
  created_at: {
19320
19619
  description:
@@ -19347,6 +19646,8 @@ const openapi: OpenAPISpec = {
19347
19646
  connected_account_warnings: {
19348
19647
  description: 'Warnings associated with the connected account.',
19349
19648
  items: {
19649
+ description:
19650
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19350
19651
  properties: {
19351
19652
  created_at: {
19352
19653
  description:
@@ -19386,6 +19687,8 @@ const openapi: OpenAPISpec = {
19386
19687
  device_errors: {
19387
19688
  description: 'Errors associated with the device.',
19388
19689
  items: {
19690
+ description:
19691
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19389
19692
  properties: {
19390
19693
  created_at: {
19391
19694
  description:
@@ -19418,6 +19721,8 @@ const openapi: OpenAPISpec = {
19418
19721
  device_warnings: {
19419
19722
  description: 'Warnings associated with the device.',
19420
19723
  items: {
19724
+ description:
19725
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19421
19726
  properties: {
19422
19727
  created_at: {
19423
19728
  description:
@@ -20426,6 +20731,8 @@ const openapi: OpenAPISpec = {
20426
20731
  description:
20427
20732
  'Errors associated with the access control system.',
20428
20733
  items: {
20734
+ description:
20735
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20429
20736
  properties: {
20430
20737
  created_at: {
20431
20738
  description:
@@ -20458,6 +20765,8 @@ const openapi: OpenAPISpec = {
20458
20765
  description:
20459
20766
  'Warnings associated with the access control system.',
20460
20767
  items: {
20768
+ description:
20769
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20461
20770
  properties: {
20462
20771
  created_at: {
20463
20772
  description:
@@ -20484,6 +20793,8 @@ const openapi: OpenAPISpec = {
20484
20793
  connected_account_errors: {
20485
20794
  description: 'Errors associated with the connected account.',
20486
20795
  items: {
20796
+ description:
20797
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20487
20798
  properties: {
20488
20799
  created_at: {
20489
20800
  description:
@@ -20515,6 +20826,8 @@ const openapi: OpenAPISpec = {
20515
20826
  connected_account_warnings: {
20516
20827
  description: 'Warnings associated with the connected account.',
20517
20828
  items: {
20829
+ description:
20830
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20518
20831
  properties: {
20519
20832
  created_at: {
20520
20833
  description:
@@ -20799,7 +21112,11 @@ const openapi: OpenAPISpec = {
20799
21112
  format: 'uuid',
20800
21113
  type: 'string',
20801
21114
  },
20802
- acs_user_id: { format: 'uuid', type: 'string' },
21115
+ acs_user_id: {
21116
+ description: 'ID of the affected access system user.',
21117
+ format: 'uuid',
21118
+ type: 'string',
21119
+ },
20803
21120
  connected_account_id: {
20804
21121
  description: 'ID of the connected account.',
20805
21122
  format: 'uuid',
@@ -20848,7 +21165,11 @@ const openapi: OpenAPISpec = {
20848
21165
  format: 'uuid',
20849
21166
  type: 'string',
20850
21167
  },
20851
- acs_user_id: { format: 'uuid', type: 'string' },
21168
+ acs_user_id: {
21169
+ description: 'ID of the affected access system user.',
21170
+ format: 'uuid',
21171
+ type: 'string',
21172
+ },
20852
21173
  connected_account_id: {
20853
21174
  description: 'ID of the connected account.',
20854
21175
  format: 'uuid',
@@ -21053,7 +21374,11 @@ const openapi: OpenAPISpec = {
21053
21374
  description:
21054
21375
  'An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was added.',
21055
21376
  properties: {
21056
- acs_entrance_id: { format: 'uuid', type: 'string' },
21377
+ acs_entrance_id: {
21378
+ description: 'ID of the affected entrance.',
21379
+ format: 'uuid',
21380
+ type: 'string',
21381
+ },
21057
21382
  acs_system_id: {
21058
21383
  description: 'ID of the access system.',
21059
21384
  format: 'uuid',
@@ -21102,7 +21427,11 @@ const openapi: OpenAPISpec = {
21102
21427
  description:
21103
21428
  'An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was removed.',
21104
21429
  properties: {
21105
- acs_entrance_id: { format: 'uuid', type: 'string' },
21430
+ acs_entrance_id: {
21431
+ description: 'ID of the affected entrance.',
21432
+ format: 'uuid',
21433
+ type: 'string',
21434
+ },
21106
21435
  acs_system_id: {
21107
21436
  description: 'ID of the access system.',
21108
21437
  format: 'uuid',
@@ -21387,6 +21716,8 @@ const openapi: OpenAPISpec = {
21387
21716
  connected_account_errors: {
21388
21717
  description: 'Errors associated with the connected account.',
21389
21718
  items: {
21719
+ description:
21720
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21390
21721
  properties: {
21391
21722
  created_at: {
21392
21723
  description:
@@ -21418,6 +21749,8 @@ const openapi: OpenAPISpec = {
21418
21749
  connected_account_warnings: {
21419
21750
  description: 'Warnings associated with the connected account.',
21420
21751
  items: {
21752
+ description:
21753
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21421
21754
  properties: {
21422
21755
  created_at: {
21423
21756
  description:
@@ -21663,6 +21996,8 @@ const openapi: OpenAPISpec = {
21663
21996
  connected_account_errors: {
21664
21997
  description: 'Errors associated with the connected account.',
21665
21998
  items: {
21999
+ description:
22000
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21666
22001
  properties: {
21667
22002
  created_at: {
21668
22003
  description:
@@ -21694,6 +22029,8 @@ const openapi: OpenAPISpec = {
21694
22029
  connected_account_warnings: {
21695
22030
  description: 'Warnings associated with the connected account.',
21696
22031
  items: {
22032
+ description:
22033
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21697
22034
  properties: {
21698
22035
  created_at: {
21699
22036
  description:
@@ -22746,6 +23083,8 @@ const openapi: OpenAPISpec = {
22746
23083
  connected_account_errors: {
22747
23084
  description: 'Errors associated with the connected account.',
22748
23085
  items: {
23086
+ description:
23087
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
22749
23088
  properties: {
22750
23089
  created_at: {
22751
23090
  description:
@@ -22778,6 +23117,8 @@ const openapi: OpenAPISpec = {
22778
23117
  connected_account_warnings: {
22779
23118
  description: 'Warnings associated with the connected account.',
22780
23119
  items: {
23120
+ description:
23121
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
22781
23122
  properties: {
22782
23123
  created_at: {
22783
23124
  description:
@@ -22822,6 +23163,8 @@ const openapi: OpenAPISpec = {
22822
23163
  device_errors: {
22823
23164
  description: 'Errors associated with the device.',
22824
23165
  items: {
23166
+ description:
23167
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
22825
23168
  properties: {
22826
23169
  created_at: {
22827
23170
  description:
@@ -22853,6 +23196,8 @@ const openapi: OpenAPISpec = {
22853
23196
  device_warnings: {
22854
23197
  description: 'Warnings associated with the device.',
22855
23198
  items: {
23199
+ description:
23200
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
22856
23201
  properties: {
22857
23202
  created_at: {
22858
23203
  description:
@@ -22935,6 +23280,8 @@ const openapi: OpenAPISpec = {
22935
23280
  connected_account_errors: {
22936
23281
  description: 'Errors associated with the connected account.',
22937
23282
  items: {
23283
+ description:
23284
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
22938
23285
  properties: {
22939
23286
  created_at: {
22940
23287
  description:
@@ -22967,6 +23314,8 @@ const openapi: OpenAPISpec = {
22967
23314
  connected_account_warnings: {
22968
23315
  description: 'Warnings associated with the connected account.',
22969
23316
  items: {
23317
+ description:
23318
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
22970
23319
  properties: {
22971
23320
  created_at: {
22972
23321
  description:
@@ -23011,6 +23360,8 @@ const openapi: OpenAPISpec = {
23011
23360
  device_errors: {
23012
23361
  description: 'Errors associated with the device.',
23013
23362
  items: {
23363
+ description:
23364
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
23014
23365
  properties: {
23015
23366
  created_at: {
23016
23367
  description:
@@ -23042,6 +23393,8 @@ const openapi: OpenAPISpec = {
23042
23393
  device_warnings: {
23043
23394
  description: 'Warnings associated with the device.',
23044
23395
  items: {
23396
+ description:
23397
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
23045
23398
  properties: {
23046
23399
  created_at: {
23047
23400
  description:
@@ -23801,6 +24154,8 @@ const openapi: OpenAPISpec = {
23801
24154
  connected_account_errors: {
23802
24155
  description: 'Errors associated with the connected account.',
23803
24156
  items: {
24157
+ description:
24158
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
23804
24159
  properties: {
23805
24160
  created_at: {
23806
24161
  description:
@@ -23833,6 +24188,8 @@ const openapi: OpenAPISpec = {
23833
24188
  connected_account_warnings: {
23834
24189
  description: 'Warnings associated with the connected account.',
23835
24190
  items: {
24191
+ description:
24192
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
23836
24193
  properties: {
23837
24194
  created_at: {
23838
24195
  description:
@@ -23877,6 +24234,8 @@ const openapi: OpenAPISpec = {
23877
24234
  device_errors: {
23878
24235
  description: 'Errors associated with the device.',
23879
24236
  items: {
24237
+ description:
24238
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
23880
24239
  properties: {
23881
24240
  created_at: {
23882
24241
  description:
@@ -23908,6 +24267,8 @@ const openapi: OpenAPISpec = {
23908
24267
  device_warnings: {
23909
24268
  description: 'Warnings associated with the device.',
23910
24269
  items: {
24270
+ description:
24271
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
23911
24272
  properties: {
23912
24273
  created_at: {
23913
24274
  description:
@@ -24055,6 +24416,8 @@ const openapi: OpenAPISpec = {
24055
24416
  connected_account_errors: {
24056
24417
  description: 'Errors associated with the connected account.',
24057
24418
  items: {
24419
+ description:
24420
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
24058
24421
  properties: {
24059
24422
  created_at: {
24060
24423
  description:
@@ -24087,6 +24450,8 @@ const openapi: OpenAPISpec = {
24087
24450
  connected_account_warnings: {
24088
24451
  description: 'Warnings associated with the connected account.',
24089
24452
  items: {
24453
+ description:
24454
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
24090
24455
  properties: {
24091
24456
  created_at: {
24092
24457
  description:
@@ -24131,6 +24496,8 @@ const openapi: OpenAPISpec = {
24131
24496
  device_errors: {
24132
24497
  description: 'Errors associated with the device.',
24133
24498
  items: {
24499
+ description:
24500
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
24134
24501
  properties: {
24135
24502
  created_at: {
24136
24503
  description:
@@ -24162,6 +24529,8 @@ const openapi: OpenAPISpec = {
24162
24529
  device_warnings: {
24163
24530
  description: 'Warnings associated with the device.',
24164
24531
  items: {
24532
+ description:
24533
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
24165
24534
  properties: {
24166
24535
  created_at: {
24167
24536
  description:
@@ -24380,6 +24749,8 @@ const openapi: OpenAPISpec = {
24380
24749
  connected_account_errors: {
24381
24750
  description: 'Errors associated with the connected account.',
24382
24751
  items: {
24752
+ description:
24753
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
24383
24754
  properties: {
24384
24755
  created_at: {
24385
24756
  description:
@@ -24412,6 +24783,8 @@ const openapi: OpenAPISpec = {
24412
24783
  connected_account_warnings: {
24413
24784
  description: 'Warnings associated with the connected account.',
24414
24785
  items: {
24786
+ description:
24787
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
24415
24788
  properties: {
24416
24789
  created_at: {
24417
24790
  description:
@@ -24456,6 +24829,8 @@ const openapi: OpenAPISpec = {
24456
24829
  device_errors: {
24457
24830
  description: 'Errors associated with the device.',
24458
24831
  items: {
24832
+ description:
24833
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
24459
24834
  properties: {
24460
24835
  created_at: {
24461
24836
  description:
@@ -24487,6 +24862,8 @@ const openapi: OpenAPISpec = {
24487
24862
  device_warnings: {
24488
24863
  description: 'Warnings associated with the device.',
24489
24864
  items: {
24865
+ description:
24866
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
24490
24867
  properties: {
24491
24868
  created_at: {
24492
24869
  description:
@@ -26337,7 +26714,8 @@ const openapi: OpenAPISpec = {
26337
26714
  type: 'string',
26338
26715
  },
26339
26716
  device_type: {
26340
- description: 'Device type for phones.\n ',
26717
+ description:
26718
+ 'Type of the phone device, such as `ios_phone` or `android_phone`.',
26341
26719
  enum: ['ios_phone', 'android_phone'],
26342
26720
  type: 'string',
26343
26721
  },
@@ -26350,8 +26728,14 @@ const openapi: OpenAPISpec = {
26350
26728
  description: 'Errors associated with the phone.',
26351
26729
  items: {
26352
26730
  properties: {
26353
- error_code: { type: 'string' },
26354
- message: { type: 'string' },
26731
+ error_code: {
26732
+ description: 'Unique identifier of the type of error.',
26733
+ type: 'string',
26734
+ },
26735
+ message: {
26736
+ description: 'Detailed description of the error.',
26737
+ type: 'string',
26738
+ },
26355
26739
  },
26356
26740
  required: ['error_code', 'message'],
26357
26741
  type: 'object',
@@ -26364,7 +26748,7 @@ const openapi: OpenAPISpec = {
26364
26748
  type: 'string',
26365
26749
  },
26366
26750
  properties: {
26367
- description: '\n Properties of the phone.\n ',
26751
+ description: 'Properties of the phone.',
26368
26752
  properties: {
26369
26753
  assa_abloy_credential_service_metadata: {
26370
26754
  description:
@@ -26418,8 +26802,14 @@ const openapi: OpenAPISpec = {
26418
26802
  description: 'Warnings associated with the phone.',
26419
26803
  items: {
26420
26804
  properties: {
26421
- message: { type: 'string' },
26422
- warning_code: { type: 'string' },
26805
+ message: {
26806
+ description: 'Detailed description of the warning.',
26807
+ type: 'string',
26808
+ },
26809
+ warning_code: {
26810
+ description: 'Unique identifier of the type of warning.',
26811
+ type: 'string',
26812
+ },
26423
26813
  },
26424
26814
  required: ['warning_code', 'message'],
26425
26815
  type: 'object',
@@ -26501,6 +26891,8 @@ const openapi: OpenAPISpec = {
26501
26891
  },
26502
26892
  acs_credential_id: { nullable: true, type: 'string' },
26503
26893
  acs_credential_pool_id: {
26894
+ description:
26895
+ 'ID of the credential pool to which the credential belongs.',
26504
26896
  format: 'uuid',
26505
26897
  type: 'string',
26506
26898
  },
@@ -27214,7 +27606,12 @@ const openapi: OpenAPISpec = {
27214
27606
  nullable: true,
27215
27607
  type: 'boolean',
27216
27608
  },
27217
- is_managed: { enum: [true], type: 'boolean' },
27609
+ is_managed: {
27610
+ description:
27611
+ 'Indicates whether Seam manages the credential.',
27612
+ enum: [true],
27613
+ type: 'boolean',
27614
+ },
27218
27615
  is_multi_phone_sync_credential: {
27219
27616
  description:
27220
27617
  'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
@@ -27570,7 +27967,11 @@ const openapi: OpenAPISpec = {
27570
27967
  format: 'date-time',
27571
27968
  type: 'string',
27572
27969
  },
27573
- display_name: { minLength: 1, type: 'string' },
27970
+ display_name: {
27971
+ description: 'Display name for the user identity.',
27972
+ minLength: 1,
27973
+ type: 'string',
27974
+ },
27574
27975
  email_address: {
27575
27976
  description: 'Unique email address for the user identity.',
27576
27977
  format: 'email',
@@ -27631,7 +28032,13 @@ const openapi: OpenAPISpec = {
27631
28032
  },
27632
28033
  type: 'array',
27633
28034
  },
27634
- full_name: { minLength: 1, nullable: true, type: 'string' },
28035
+ full_name: {
28036
+ description:
28037
+ 'Full name of the user associated with the user identity.',
28038
+ minLength: 1,
28039
+ nullable: true,
28040
+ type: 'string',
28041
+ },
27635
28042
  phone_number: {
27636
28043
  description:
27637
28044
  'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
@@ -29705,7 +30112,10 @@ const openapi: OpenAPISpec = {
29705
30112
  format: 'date-time',
29706
30113
  type: 'string',
29707
30114
  },
29708
- display_name: { type: 'string' },
30115
+ display_name: {
30116
+ description: 'Display name for the access group.',
30117
+ type: 'string',
30118
+ },
29709
30119
  errors: {
29710
30120
  description: 'Errors associated with the `acs_access_group`.',
29711
30121
  items: {
@@ -30221,7 +30631,12 @@ const openapi: OpenAPISpec = {
30221
30631
  format: 'uuid',
30222
30632
  type: 'string',
30223
30633
  },
30224
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
30634
+ acs_credential_pool_id: {
30635
+ description:
30636
+ 'ID of the credential pool to which the credential belongs.',
30637
+ format: 'uuid',
30638
+ type: 'string',
30639
+ },
30225
30640
  acs_system_id: {
30226
30641
  description:
30227
30642
  'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -30873,7 +31288,12 @@ const openapi: OpenAPISpec = {
30873
31288
  minLength: 1,
30874
31289
  type: 'string',
30875
31290
  },
30876
- hid_acs_system_id: { format: 'uuid', type: 'string' },
31291
+ hid_acs_system_id: {
31292
+ description:
31293
+ 'ID of the HID access control system associated with the user.',
31294
+ format: 'uuid',
31295
+ type: 'string',
31296
+ },
30877
31297
  is_managed: { enum: [false], type: 'boolean' },
30878
31298
  is_suspended: {
30879
31299
  description:
@@ -31489,30 +31909,103 @@ const openapi: OpenAPISpec = {
31489
31909
  description:
31490
31910
  'Represents an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
31491
31911
  properties: {
31492
- can_configure_auto_lock: { type: 'boolean' },
31493
- can_hvac_cool: { type: 'boolean' },
31494
- can_hvac_heat: { type: 'boolean' },
31495
- can_hvac_heat_cool: { type: 'boolean' },
31496
- can_program_offline_access_codes: { type: 'boolean' },
31497
- can_program_online_access_codes: { type: 'boolean' },
31912
+ can_configure_auto_lock: {
31913
+ description:
31914
+ 'Indicates whether the lock supports configuring automatic locking.',
31915
+ type: 'boolean',
31916
+ },
31917
+ can_hvac_cool: {
31918
+ description: 'Indicates whether the thermostat supports cooling.',
31919
+ type: 'boolean',
31920
+ },
31921
+ can_hvac_heat: {
31922
+ description: 'Indicates whether the thermostat supports heating.',
31923
+ type: 'boolean',
31924
+ },
31925
+ can_hvac_heat_cool: {
31926
+ description:
31927
+ 'Indicates whether the thermostat supports simultaneous heating and cooling.',
31928
+ type: 'boolean',
31929
+ },
31930
+ can_program_offline_access_codes: {
31931
+ description:
31932
+ 'Indicates whether the device supports programming offline access codes.',
31933
+ type: 'boolean',
31934
+ },
31935
+ can_program_online_access_codes: {
31936
+ description:
31937
+ 'Indicates whether the device supports programming online access codes.',
31938
+ type: 'boolean',
31939
+ },
31498
31940
  can_program_thermostat_programs_as_different_each_day: {
31941
+ description:
31942
+ 'Indicates whether the thermostat supports different climate programs for each day of the week.',
31943
+ type: 'boolean',
31944
+ },
31945
+ can_program_thermostat_programs_as_same_each_day: {
31946
+ description:
31947
+ 'Indicates whether the thermostat supports a single climate program applied to every day.',
31499
31948
  type: 'boolean',
31500
31949
  },
31501
- can_program_thermostat_programs_as_same_each_day: { type: 'boolean' },
31502
31950
  can_program_thermostat_programs_as_weekday_weekend: {
31951
+ description:
31952
+ 'Indicates whether the thermostat supports weekday/weekend climate programs.',
31953
+ type: 'boolean',
31954
+ },
31955
+ can_remotely_lock: {
31956
+ description:
31957
+ 'Indicates whether the device supports remote locking.',
31958
+ type: 'boolean',
31959
+ },
31960
+ can_remotely_unlock: {
31961
+ description:
31962
+ 'Indicates whether the device supports remote unlocking.',
31963
+ type: 'boolean',
31964
+ },
31965
+ can_run_thermostat_programs: {
31966
+ description:
31967
+ 'Indicates whether the thermostat supports running climate programs.',
31968
+ type: 'boolean',
31969
+ },
31970
+ can_simulate_connection: {
31971
+ description:
31972
+ 'Indicates whether the device supports simulating connection in a sandbox.',
31973
+ type: 'boolean',
31974
+ },
31975
+ can_simulate_disconnection: {
31976
+ description:
31977
+ 'Indicates whether the device supports simulating disconnection in a sandbox.',
31978
+ type: 'boolean',
31979
+ },
31980
+ can_simulate_hub_connection: {
31981
+ description:
31982
+ 'Indicates whether the hub supports simulating connection in a sandbox.',
31983
+ type: 'boolean',
31984
+ },
31985
+ can_simulate_hub_disconnection: {
31986
+ description:
31987
+ 'Indicates whether the hub supports simulating disconnection in a sandbox.',
31988
+ type: 'boolean',
31989
+ },
31990
+ can_simulate_paid_subscription: {
31991
+ description:
31992
+ 'Indicates whether the device supports simulating a paid subscription in a sandbox.',
31993
+ type: 'boolean',
31994
+ },
31995
+ can_simulate_removal: {
31996
+ description:
31997
+ 'Indicates whether the device supports simulating removal in a sandbox.',
31998
+ type: 'boolean',
31999
+ },
32000
+ can_turn_off_hvac: {
32001
+ description: 'Indicates whether the thermostat can be turned off.',
32002
+ type: 'boolean',
32003
+ },
32004
+ can_unlock_with_code: {
32005
+ description:
32006
+ 'Indicates whether the lock supports unlocking with an access code.',
31503
32007
  type: 'boolean',
31504
32008
  },
31505
- can_remotely_lock: { type: 'boolean' },
31506
- can_remotely_unlock: { type: 'boolean' },
31507
- can_run_thermostat_programs: { type: 'boolean' },
31508
- can_simulate_connection: { type: 'boolean' },
31509
- can_simulate_disconnection: { type: 'boolean' },
31510
- can_simulate_hub_connection: { type: 'boolean' },
31511
- can_simulate_hub_disconnection: { type: 'boolean' },
31512
- can_simulate_paid_subscription: { type: 'boolean' },
31513
- can_simulate_removal: { type: 'boolean' },
31514
- can_turn_off_hvac: { type: 'boolean' },
31515
- can_unlock_with_code: { type: 'boolean' },
31516
32009
  capabilities_supported: {
31517
32010
  description:
31518
32011
  '\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ',
@@ -32240,7 +32733,11 @@ const openapi: OpenAPISpec = {
32240
32733
  thermostats: { name: 'Thermostats' },
32241
32734
  },
32242
32735
  },
32243
- is_managed: { enum: [false], type: 'boolean' },
32736
+ is_managed: {
32737
+ description: 'Indicates that Seam does not manage the device.',
32738
+ enum: [false],
32739
+ type: 'boolean',
32740
+ },
32244
32741
  location: {
32245
32742
  description: 'Location information for the device.',
32246
32743
  properties: {
@@ -33176,7 +33673,11 @@ const openapi: OpenAPISpec = {
33176
33673
  format: 'date-time',
33177
33674
  type: 'string',
33178
33675
  },
33179
- display_name: { minLength: 1, type: 'string' },
33676
+ display_name: {
33677
+ description: 'Display name for the user identity.',
33678
+ minLength: 1,
33679
+ type: 'string',
33680
+ },
33180
33681
  email_address: {
33181
33682
  description: 'Unique email address for the user identity.',
33182
33683
  format: 'email',
@@ -33237,7 +33738,13 @@ const openapi: OpenAPISpec = {
33237
33738
  },
33238
33739
  type: 'array',
33239
33740
  },
33240
- full_name: { minLength: 1, nullable: true, type: 'string' },
33741
+ full_name: {
33742
+ description:
33743
+ 'Full name of the user associated with the user identity.',
33744
+ minLength: 1,
33745
+ nullable: true,
33746
+ type: 'string',
33747
+ },
33241
33748
  phone_number: {
33242
33749
  description:
33243
33750
  'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
@@ -36595,6 +37102,8 @@ const openapi: OpenAPISpec = {
36595
37102
  type: 'string',
36596
37103
  },
36597
37104
  full_name: {
37105
+ description:
37106
+ 'Full name of the user associated with the user identity.',
36598
37107
  minLength: 1,
36599
37108
  nullable: true,
36600
37109
  type: 'string',
@@ -49856,7 +50365,12 @@ const openapi: OpenAPISpec = {
49856
50365
  minLength: 1,
49857
50366
  type: 'string',
49858
50367
  },
49859
- hid_acs_system_id: { format: 'uuid', type: 'string' },
50368
+ hid_acs_system_id: {
50369
+ description:
50370
+ 'ID of the HID access control system associated with the user.',
50371
+ format: 'uuid',
50372
+ type: 'string',
50373
+ },
49860
50374
  phone_number: {
49861
50375
  description:
49862
50376
  'Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
@@ -49962,7 +50476,12 @@ const openapi: OpenAPISpec = {
49962
50476
  minLength: 1,
49963
50477
  type: 'string',
49964
50478
  },
49965
- hid_acs_system_id: { format: 'uuid', type: 'string' },
50479
+ hid_acs_system_id: {
50480
+ description:
50481
+ 'ID of the HID access control system associated with the user.',
50482
+ format: 'uuid',
50483
+ type: 'string',
50484
+ },
49966
50485
  phone_number: {
49967
50486
  description:
49968
50487
  'Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
@@ -81208,6 +81727,8 @@ const openapi: OpenAPISpec = {
81208
81727
  },
81209
81728
  fan_mode: {
81210
81729
  deprecated: true,
81730
+ description:
81731
+ 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.',
81211
81732
  enum: ['auto', 'on', 'circulate'],
81212
81733
  type: 'string',
81213
81734
  'x-deprecated': 'Use `fan_mode_setting` instead.',
@@ -84720,7 +85241,11 @@ const openapi: OpenAPISpec = {
84720
85241
  format: 'date-time',
84721
85242
  type: 'string',
84722
85243
  },
84723
- display_name: { minLength: 1, type: 'string' },
85244
+ display_name: {
85245
+ description: 'Display name for the user identity.',
85246
+ minLength: 1,
85247
+ type: 'string',
85248
+ },
84724
85249
  email_address: {
84725
85250
  description:
84726
85251
  'Unique email address for the user identity.',
@@ -84784,6 +85309,8 @@ const openapi: OpenAPISpec = {
84784
85309
  type: 'array',
84785
85310
  },
84786
85311
  full_name: {
85312
+ description:
85313
+ 'Full name of the user associated with the user identity.',
84787
85314
  minLength: 1,
84788
85315
  nullable: true,
84789
85316
  type: 'string',
@@ -84963,7 +85490,11 @@ const openapi: OpenAPISpec = {
84963
85490
  format: 'date-time',
84964
85491
  type: 'string',
84965
85492
  },
84966
- display_name: { minLength: 1, type: 'string' },
85493
+ display_name: {
85494
+ description: 'Display name for the user identity.',
85495
+ minLength: 1,
85496
+ type: 'string',
85497
+ },
84967
85498
  email_address: {
84968
85499
  description:
84969
85500
  'Unique email address for the user identity.',
@@ -85027,6 +85558,8 @@ const openapi: OpenAPISpec = {
85027
85558
  type: 'array',
85028
85559
  },
85029
85560
  full_name: {
85561
+ description:
85562
+ 'Full name of the user associated with the user identity.',
85030
85563
  minLength: 1,
85031
85564
  nullable: true,
85032
85565
  type: 'string',
@@ -85234,7 +85767,11 @@ const openapi: OpenAPISpec = {
85234
85767
  format: 'date-time',
85235
85768
  type: 'string',
85236
85769
  },
85237
- display_name: { minLength: 1, type: 'string' },
85770
+ display_name: {
85771
+ description: 'Display name for the user identity.',
85772
+ minLength: 1,
85773
+ type: 'string',
85774
+ },
85238
85775
  email_address: {
85239
85776
  description:
85240
85777
  'Unique email address for the user identity.',
@@ -85298,6 +85835,8 @@ const openapi: OpenAPISpec = {
85298
85835
  type: 'array',
85299
85836
  },
85300
85837
  full_name: {
85838
+ description:
85839
+ 'Full name of the user associated with the user identity.',
85301
85840
  minLength: 1,
85302
85841
  nullable: true,
85303
85842
  type: 'string',
@@ -85500,7 +86039,11 @@ const openapi: OpenAPISpec = {
85500
86039
  format: 'date-time',
85501
86040
  type: 'string',
85502
86041
  },
85503
- display_name: { minLength: 1, type: 'string' },
86042
+ display_name: {
86043
+ description: 'Display name for the user identity.',
86044
+ minLength: 1,
86045
+ type: 'string',
86046
+ },
85504
86047
  email_address: {
85505
86048
  description:
85506
86049
  'Unique email address for the user identity.',
@@ -85564,6 +86107,8 @@ const openapi: OpenAPISpec = {
85564
86107
  type: 'array',
85565
86108
  },
85566
86109
  full_name: {
86110
+ description:
86111
+ 'Full name of the user associated with the user identity.',
85567
86112
  minLength: 1,
85568
86113
  nullable: true,
85569
86114
  type: 'string',