@seamapi/types 1.916.0 → 1.918.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.
- package/dist/connect.cjs +645 -162
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +987 -23
- package/dist/index.cjs +645 -162
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +4 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +12 -3
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +15 -5
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +8 -2
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +8 -4
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device.js +60 -20
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +10 -6
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +3 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/models/events/access-codes.js +7 -3
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/acs/entrances.js +3 -5
- package/lib/seam/connect/models/events/acs/entrances.js.map +1 -1
- package/lib/seam/connect/models/events/acs/users.js +6 -5
- package/lib/seam/connect/models/events/acs/users.js.map +1 -1
- package/lib/seam/connect/models/events/common.js +8 -4
- package/lib/seam/connect/models/events/common.js.map +1 -1
- package/lib/seam/connect/models/events/devices.d.ts +30 -8
- package/lib/seam/connect/models/events/devices.js +25 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +15 -4
- package/lib/seam/connect/models/thermostats/modes.js +9 -16
- package/lib/seam/connect/models/thermostats/modes.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +9 -2
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.js +514 -97
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +972 -19
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +4 -2
- package/src/lib/seam/connect/models/acs/acs-credential.ts +14 -3
- package/src/lib/seam/connect/models/acs/acs-system.ts +25 -5
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +10 -2
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +3 -1
- package/src/lib/seam/connect/models/devices/device-provider.ts +10 -4
- package/src/lib/seam/connect/models/devices/device.ts +90 -20
- package/src/lib/seam/connect/models/devices/phone.ts +12 -6
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +3 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +18 -14
- package/src/lib/seam/connect/models/events/acs/entrances.ts +3 -5
- package/src/lib/seam/connect/models/events/acs/users.ts +6 -5
- package/src/lib/seam/connect/models/events/common.ts +32 -24
- package/src/lib/seam/connect/models/events/devices.ts +25 -0
- package/src/lib/seam/connect/models/thermostats/modes.ts +15 -16
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +9 -2
- package/src/lib/seam/connect/openapi.ts +665 -97
- package/src/lib/seam/connect/route-types.ts +972 -19
|
@@ -2566,7 +2566,10 @@ const openapi = {
|
|
|
2566
2566
|
format: 'date-time',
|
|
2567
2567
|
type: 'string',
|
|
2568
2568
|
},
|
|
2569
|
-
display_name: {
|
|
2569
|
+
display_name: {
|
|
2570
|
+
description: 'Display name for the access group.',
|
|
2571
|
+
type: 'string',
|
|
2572
|
+
},
|
|
2570
2573
|
errors: {
|
|
2571
2574
|
description: 'Errors associated with the `acs_access_group`.',
|
|
2572
2575
|
items: {
|
|
@@ -2616,7 +2619,11 @@ const openapi = {
|
|
|
2616
2619
|
description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
|
|
2617
2620
|
type: 'string',
|
|
2618
2621
|
},
|
|
2619
|
-
is_managed: {
|
|
2622
|
+
is_managed: {
|
|
2623
|
+
description: 'Indicates whether Seam manages the access group.',
|
|
2624
|
+
enum: [true],
|
|
2625
|
+
type: 'boolean',
|
|
2626
|
+
},
|
|
2620
2627
|
name: { description: 'Name of the access group.', type: 'string' },
|
|
2621
2628
|
pending_mutations: {
|
|
2622
2629
|
description: 'Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.',
|
|
@@ -3037,7 +3044,11 @@ const openapi = {
|
|
|
3037
3044
|
format: 'uuid',
|
|
3038
3045
|
type: 'string',
|
|
3039
3046
|
},
|
|
3040
|
-
acs_credential_pool_id: {
|
|
3047
|
+
acs_credential_pool_id: {
|
|
3048
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
3049
|
+
format: 'uuid',
|
|
3050
|
+
type: 'string',
|
|
3051
|
+
},
|
|
3041
3052
|
acs_system_id: {
|
|
3042
3053
|
description: '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).',
|
|
3043
3054
|
format: 'uuid',
|
|
@@ -3152,7 +3163,11 @@ const openapi = {
|
|
|
3152
3163
|
nullable: true,
|
|
3153
3164
|
type: 'boolean',
|
|
3154
3165
|
},
|
|
3155
|
-
is_managed: {
|
|
3166
|
+
is_managed: {
|
|
3167
|
+
description: 'Indicates whether Seam manages the credential.',
|
|
3168
|
+
enum: [true],
|
|
3169
|
+
type: 'boolean',
|
|
3170
|
+
},
|
|
3156
3171
|
is_multi_phone_sync_credential: {
|
|
3157
3172
|
description: '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).',
|
|
3158
3173
|
type: 'boolean',
|
|
@@ -3972,13 +3987,21 @@ const openapi = {
|
|
|
3972
3987
|
acs_system: {
|
|
3973
3988
|
description: '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).',
|
|
3974
3989
|
properties: {
|
|
3975
|
-
acs_access_group_count: {
|
|
3990
|
+
acs_access_group_count: {
|
|
3991
|
+
description: 'Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
3992
|
+
format: 'float',
|
|
3993
|
+
type: 'number',
|
|
3994
|
+
},
|
|
3976
3995
|
acs_system_id: {
|
|
3977
3996
|
description: 'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
3978
3997
|
format: 'uuid',
|
|
3979
3998
|
type: 'string',
|
|
3980
3999
|
},
|
|
3981
|
-
acs_user_count: {
|
|
4000
|
+
acs_user_count: {
|
|
4001
|
+
description: 'Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
4002
|
+
format: 'float',
|
|
4003
|
+
type: 'number',
|
|
4004
|
+
},
|
|
3982
4005
|
connected_account_id: {
|
|
3983
4006
|
description: 'ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
3984
4007
|
format: 'uuid',
|
|
@@ -4042,7 +4065,10 @@ const openapi = {
|
|
|
4042
4065
|
enum: ['bridge_disconnected'],
|
|
4043
4066
|
type: 'string',
|
|
4044
4067
|
},
|
|
4045
|
-
is_bridge_error: {
|
|
4068
|
+
is_bridge_error: {
|
|
4069
|
+
description: 'Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
|
|
4070
|
+
type: 'boolean',
|
|
4071
|
+
},
|
|
4046
4072
|
message: {
|
|
4047
4073
|
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
4048
4074
|
type: 'string',
|
|
@@ -4219,6 +4245,7 @@ const openapi = {
|
|
|
4219
4245
|
type: 'boolean',
|
|
4220
4246
|
},
|
|
4221
4247
|
location: {
|
|
4248
|
+
description: 'Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
4222
4249
|
properties: {
|
|
4223
4250
|
time_zone: {
|
|
4224
4251
|
description: 'Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located.',
|
|
@@ -4261,6 +4288,7 @@ const openapi = {
|
|
|
4261
4288
|
'x-deprecated': 'Use `external_type_display_name`.',
|
|
4262
4289
|
},
|
|
4263
4290
|
visionline_metadata: {
|
|
4291
|
+
description: 'Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
4264
4292
|
properties: {
|
|
4265
4293
|
lan_address: {
|
|
4266
4294
|
description: 'IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network.',
|
|
@@ -4589,8 +4617,16 @@ const openapi = {
|
|
|
4589
4617
|
minLength: 1,
|
|
4590
4618
|
type: 'string',
|
|
4591
4619
|
},
|
|
4592
|
-
hid_acs_system_id: {
|
|
4593
|
-
|
|
4620
|
+
hid_acs_system_id: {
|
|
4621
|
+
description: 'ID of the HID access control system associated with the user.',
|
|
4622
|
+
format: 'uuid',
|
|
4623
|
+
type: 'string',
|
|
4624
|
+
},
|
|
4625
|
+
is_managed: {
|
|
4626
|
+
description: 'Indicates whether Seam manages the access system user.',
|
|
4627
|
+
enum: [true],
|
|
4628
|
+
type: 'boolean',
|
|
4629
|
+
},
|
|
4594
4630
|
is_suspended: {
|
|
4595
4631
|
description: '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).',
|
|
4596
4632
|
type: 'boolean',
|
|
@@ -5438,7 +5474,11 @@ const openapi = {
|
|
|
5438
5474
|
nullable: true,
|
|
5439
5475
|
type: 'string',
|
|
5440
5476
|
},
|
|
5441
|
-
is_issued: {
|
|
5477
|
+
is_issued: {
|
|
5478
|
+
description: 'Indicates whether the credential has been issued (encoded onto a card).',
|
|
5479
|
+
nullable: true,
|
|
5480
|
+
type: 'boolean',
|
|
5481
|
+
},
|
|
5442
5482
|
starts_at: {
|
|
5443
5483
|
description: 'Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable.',
|
|
5444
5484
|
format: 'date-time',
|
|
@@ -5541,6 +5581,7 @@ const openapi = {
|
|
|
5541
5581
|
type: 'string',
|
|
5542
5582
|
},
|
|
5543
5583
|
acs_credential_pool_id: {
|
|
5584
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
5544
5585
|
format: 'uuid',
|
|
5545
5586
|
type: 'string',
|
|
5546
5587
|
},
|
|
@@ -5658,7 +5699,11 @@ const openapi = {
|
|
|
5658
5699
|
nullable: true,
|
|
5659
5700
|
type: 'boolean',
|
|
5660
5701
|
},
|
|
5661
|
-
is_managed: {
|
|
5702
|
+
is_managed: {
|
|
5703
|
+
description: 'Indicates whether Seam manages the credential.',
|
|
5704
|
+
enum: [true],
|
|
5705
|
+
type: 'boolean',
|
|
5706
|
+
},
|
|
5662
5707
|
is_multi_phone_sync_credential: {
|
|
5663
5708
|
description: '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).',
|
|
5664
5709
|
type: 'boolean',
|
|
@@ -5933,6 +5978,7 @@ const openapi = {
|
|
|
5933
5978
|
type: 'string',
|
|
5934
5979
|
},
|
|
5935
5980
|
acs_credential_pool_id: {
|
|
5981
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
5936
5982
|
format: 'uuid',
|
|
5937
5983
|
type: 'string',
|
|
5938
5984
|
},
|
|
@@ -6551,6 +6597,7 @@ const openapi = {
|
|
|
6551
6597
|
type: 'string',
|
|
6552
6598
|
},
|
|
6553
6599
|
acs_credential_pool_id: {
|
|
6600
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
6554
6601
|
format: 'uuid',
|
|
6555
6602
|
type: 'string',
|
|
6556
6603
|
},
|
|
@@ -6668,7 +6715,11 @@ const openapi = {
|
|
|
6668
6715
|
nullable: true,
|
|
6669
6716
|
type: 'boolean',
|
|
6670
6717
|
},
|
|
6671
|
-
is_managed: {
|
|
6718
|
+
is_managed: {
|
|
6719
|
+
description: 'Indicates whether Seam manages the credential.',
|
|
6720
|
+
enum: [true],
|
|
6721
|
+
type: 'boolean',
|
|
6722
|
+
},
|
|
6672
6723
|
is_multi_phone_sync_credential: {
|
|
6673
6724
|
description: '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).',
|
|
6674
6725
|
type: 'boolean',
|
|
@@ -6941,6 +6992,7 @@ const openapi = {
|
|
|
6941
6992
|
type: 'string',
|
|
6942
6993
|
},
|
|
6943
6994
|
acs_credential_pool_id: {
|
|
6995
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
6944
6996
|
format: 'uuid',
|
|
6945
6997
|
type: 'string',
|
|
6946
6998
|
},
|
|
@@ -7585,7 +7637,11 @@ const openapi = {
|
|
|
7585
7637
|
format: 'uuid',
|
|
7586
7638
|
type: 'string',
|
|
7587
7639
|
},
|
|
7588
|
-
acs_credential_pool_id: {
|
|
7640
|
+
acs_credential_pool_id: {
|
|
7641
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
7642
|
+
format: 'uuid',
|
|
7643
|
+
type: 'string',
|
|
7644
|
+
},
|
|
7589
7645
|
acs_system_id: {
|
|
7590
7646
|
description: '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).',
|
|
7591
7647
|
format: 'uuid',
|
|
@@ -7700,7 +7756,11 @@ const openapi = {
|
|
|
7700
7756
|
nullable: true,
|
|
7701
7757
|
type: 'boolean',
|
|
7702
7758
|
},
|
|
7703
|
-
is_managed: {
|
|
7759
|
+
is_managed: {
|
|
7760
|
+
description: 'Indicates whether Seam manages the credential.',
|
|
7761
|
+
enum: [true],
|
|
7762
|
+
type: 'boolean',
|
|
7763
|
+
},
|
|
7704
7764
|
is_multi_phone_sync_credential: {
|
|
7705
7765
|
description: '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).',
|
|
7706
7766
|
type: 'boolean',
|
|
@@ -10586,6 +10646,7 @@ const openapi = {
|
|
|
10586
10646
|
type: 'string',
|
|
10587
10647
|
},
|
|
10588
10648
|
device_selection_mode: {
|
|
10649
|
+
description: 'Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.',
|
|
10589
10650
|
enum: ['none', 'single', 'multiple'],
|
|
10590
10651
|
type: 'string',
|
|
10591
10652
|
},
|
|
@@ -11264,30 +11325,86 @@ const openapi = {
|
|
|
11264
11325
|
device: {
|
|
11265
11326
|
description: 'Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.',
|
|
11266
11327
|
properties: {
|
|
11267
|
-
can_configure_auto_lock: {
|
|
11268
|
-
|
|
11269
|
-
|
|
11270
|
-
|
|
11271
|
-
|
|
11272
|
-
|
|
11328
|
+
can_configure_auto_lock: {
|
|
11329
|
+
description: 'Indicates whether the lock supports configuring automatic locking.',
|
|
11330
|
+
type: 'boolean',
|
|
11331
|
+
},
|
|
11332
|
+
can_hvac_cool: {
|
|
11333
|
+
description: 'Indicates whether the thermostat supports cooling.',
|
|
11334
|
+
type: 'boolean',
|
|
11335
|
+
},
|
|
11336
|
+
can_hvac_heat: {
|
|
11337
|
+
description: 'Indicates whether the thermostat supports heating.',
|
|
11338
|
+
type: 'boolean',
|
|
11339
|
+
},
|
|
11340
|
+
can_hvac_heat_cool: {
|
|
11341
|
+
description: 'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
11342
|
+
type: 'boolean',
|
|
11343
|
+
},
|
|
11344
|
+
can_program_offline_access_codes: {
|
|
11345
|
+
description: 'Indicates whether the device supports programming offline access codes.',
|
|
11346
|
+
type: 'boolean',
|
|
11347
|
+
},
|
|
11348
|
+
can_program_online_access_codes: {
|
|
11349
|
+
description: 'Indicates whether the device supports programming online access codes.',
|
|
11350
|
+
type: 'boolean',
|
|
11351
|
+
},
|
|
11273
11352
|
can_program_thermostat_programs_as_different_each_day: {
|
|
11353
|
+
description: 'Indicates whether the thermostat supports different climate programs for each day of the week.',
|
|
11354
|
+
type: 'boolean',
|
|
11355
|
+
},
|
|
11356
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
11357
|
+
description: 'Indicates whether the thermostat supports a single climate program applied to every day.',
|
|
11274
11358
|
type: 'boolean',
|
|
11275
11359
|
},
|
|
11276
|
-
can_program_thermostat_programs_as_same_each_day: { type: 'boolean' },
|
|
11277
11360
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
11361
|
+
description: 'Indicates whether the thermostat supports weekday/weekend climate programs.',
|
|
11362
|
+
type: 'boolean',
|
|
11363
|
+
},
|
|
11364
|
+
can_remotely_lock: {
|
|
11365
|
+
description: 'Indicates whether the device supports remote locking.',
|
|
11366
|
+
type: 'boolean',
|
|
11367
|
+
},
|
|
11368
|
+
can_remotely_unlock: {
|
|
11369
|
+
description: 'Indicates whether the device supports remote unlocking.',
|
|
11370
|
+
type: 'boolean',
|
|
11371
|
+
},
|
|
11372
|
+
can_run_thermostat_programs: {
|
|
11373
|
+
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
11374
|
+
type: 'boolean',
|
|
11375
|
+
},
|
|
11376
|
+
can_simulate_connection: {
|
|
11377
|
+
description: 'Indicates whether the device supports simulating connection in a sandbox.',
|
|
11378
|
+
type: 'boolean',
|
|
11379
|
+
},
|
|
11380
|
+
can_simulate_disconnection: {
|
|
11381
|
+
description: 'Indicates whether the device supports simulating disconnection in a sandbox.',
|
|
11382
|
+
type: 'boolean',
|
|
11383
|
+
},
|
|
11384
|
+
can_simulate_hub_connection: {
|
|
11385
|
+
description: 'Indicates whether the hub supports simulating connection in a sandbox.',
|
|
11386
|
+
type: 'boolean',
|
|
11387
|
+
},
|
|
11388
|
+
can_simulate_hub_disconnection: {
|
|
11389
|
+
description: 'Indicates whether the hub supports simulating disconnection in a sandbox.',
|
|
11390
|
+
type: 'boolean',
|
|
11391
|
+
},
|
|
11392
|
+
can_simulate_paid_subscription: {
|
|
11393
|
+
description: 'Indicates whether the device supports simulating a paid subscription in a sandbox.',
|
|
11394
|
+
type: 'boolean',
|
|
11395
|
+
},
|
|
11396
|
+
can_simulate_removal: {
|
|
11397
|
+
description: 'Indicates whether the device supports simulating removal in a sandbox.',
|
|
11398
|
+
type: 'boolean',
|
|
11399
|
+
},
|
|
11400
|
+
can_turn_off_hvac: {
|
|
11401
|
+
description: 'Indicates whether the thermostat can be turned off.',
|
|
11402
|
+
type: 'boolean',
|
|
11403
|
+
},
|
|
11404
|
+
can_unlock_with_code: {
|
|
11405
|
+
description: 'Indicates whether the lock supports unlocking with an access code.',
|
|
11278
11406
|
type: 'boolean',
|
|
11279
11407
|
},
|
|
11280
|
-
can_remotely_lock: { type: 'boolean' },
|
|
11281
|
-
can_remotely_unlock: { type: 'boolean' },
|
|
11282
|
-
can_run_thermostat_programs: { type: 'boolean' },
|
|
11283
|
-
can_simulate_connection: { type: 'boolean' },
|
|
11284
|
-
can_simulate_disconnection: { type: 'boolean' },
|
|
11285
|
-
can_simulate_hub_connection: { type: 'boolean' },
|
|
11286
|
-
can_simulate_hub_disconnection: { type: 'boolean' },
|
|
11287
|
-
can_simulate_paid_subscription: { type: 'boolean' },
|
|
11288
|
-
can_simulate_removal: { type: 'boolean' },
|
|
11289
|
-
can_turn_off_hvac: { type: 'boolean' },
|
|
11290
|
-
can_unlock_with_code: { type: 'boolean' },
|
|
11291
11408
|
capabilities_supported: {
|
|
11292
11409
|
description: '\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 ',
|
|
11293
11410
|
items: {
|
|
@@ -13759,6 +13876,7 @@ const openapi = {
|
|
|
13759
13876
|
available_climate_preset_modes: {
|
|
13760
13877
|
description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
|
|
13761
13878
|
items: {
|
|
13879
|
+
description: 'Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.',
|
|
13762
13880
|
enum: [
|
|
13763
13881
|
'home',
|
|
13764
13882
|
'away',
|
|
@@ -13892,6 +14010,7 @@ const openapi = {
|
|
|
13892
14010
|
available_fan_mode_settings: {
|
|
13893
14011
|
description: 'Fan mode settings that the thermostat supports.',
|
|
13894
14012
|
items: {
|
|
14013
|
+
description: 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.',
|
|
13895
14014
|
enum: ['auto', 'on', 'circulate'],
|
|
13896
14015
|
type: 'string',
|
|
13897
14016
|
},
|
|
@@ -13901,6 +14020,7 @@ const openapi = {
|
|
|
13901
14020
|
available_hvac_mode_settings: {
|
|
13902
14021
|
description: 'HVAC mode settings that the thermostat supports.',
|
|
13903
14022
|
items: {
|
|
14023
|
+
description: 'HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.',
|
|
13904
14024
|
enum: ['off', 'heat', 'cool', 'heat_cool', 'eco'],
|
|
13905
14025
|
type: 'string',
|
|
13906
14026
|
},
|
|
@@ -15065,31 +15185,88 @@ const openapi = {
|
|
|
15065
15185
|
},
|
|
15066
15186
|
device_provider: {
|
|
15067
15187
|
properties: {
|
|
15068
|
-
can_configure_auto_lock: {
|
|
15069
|
-
|
|
15070
|
-
|
|
15071
|
-
|
|
15072
|
-
|
|
15073
|
-
|
|
15188
|
+
can_configure_auto_lock: {
|
|
15189
|
+
description: 'Indicates whether the lock supports configuring automatic locking.',
|
|
15190
|
+
type: 'boolean',
|
|
15191
|
+
},
|
|
15192
|
+
can_hvac_cool: {
|
|
15193
|
+
description: 'Indicates whether the thermostat supports cooling.',
|
|
15194
|
+
type: 'boolean',
|
|
15195
|
+
},
|
|
15196
|
+
can_hvac_heat: {
|
|
15197
|
+
description: 'Indicates whether the thermostat supports heating.',
|
|
15198
|
+
type: 'boolean',
|
|
15199
|
+
},
|
|
15200
|
+
can_hvac_heat_cool: {
|
|
15201
|
+
description: 'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
15202
|
+
type: 'boolean',
|
|
15203
|
+
},
|
|
15204
|
+
can_program_offline_access_codes: {
|
|
15205
|
+
description: 'Indicates whether the device supports programming offline access codes.',
|
|
15206
|
+
type: 'boolean',
|
|
15207
|
+
},
|
|
15208
|
+
can_program_online_access_codes: {
|
|
15209
|
+
description: 'Indicates whether the device supports programming online access codes.',
|
|
15210
|
+
type: 'boolean',
|
|
15211
|
+
},
|
|
15074
15212
|
can_program_thermostat_programs_as_different_each_day: {
|
|
15213
|
+
description: 'Indicates whether the thermostat supports different climate programs for each day of the week.',
|
|
15214
|
+
type: 'boolean',
|
|
15215
|
+
},
|
|
15216
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
15217
|
+
description: 'Indicates whether the thermostat supports a single climate program applied to every day.',
|
|
15075
15218
|
type: 'boolean',
|
|
15076
15219
|
},
|
|
15077
|
-
can_program_thermostat_programs_as_same_each_day: { type: 'boolean' },
|
|
15078
15220
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
15221
|
+
description: 'Indicates whether the thermostat supports weekday/weekend climate programs.',
|
|
15222
|
+
type: 'boolean',
|
|
15223
|
+
},
|
|
15224
|
+
can_remotely_lock: {
|
|
15225
|
+
description: 'Indicates whether the device supports remote locking.',
|
|
15226
|
+
type: 'boolean',
|
|
15227
|
+
},
|
|
15228
|
+
can_remotely_unlock: {
|
|
15229
|
+
description: 'Indicates whether the device supports remote unlocking.',
|
|
15230
|
+
type: 'boolean',
|
|
15231
|
+
},
|
|
15232
|
+
can_run_thermostat_programs: {
|
|
15233
|
+
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
15234
|
+
type: 'boolean',
|
|
15235
|
+
},
|
|
15236
|
+
can_simulate_connection: {
|
|
15237
|
+
description: 'Indicates whether the device supports simulating connection in a sandbox.',
|
|
15238
|
+
type: 'boolean',
|
|
15239
|
+
},
|
|
15240
|
+
can_simulate_disconnection: {
|
|
15241
|
+
description: 'Indicates whether the device supports simulating disconnection in a sandbox.',
|
|
15242
|
+
type: 'boolean',
|
|
15243
|
+
},
|
|
15244
|
+
can_simulate_hub_connection: {
|
|
15245
|
+
description: 'Indicates whether the hub supports simulating connection in a sandbox.',
|
|
15246
|
+
type: 'boolean',
|
|
15247
|
+
},
|
|
15248
|
+
can_simulate_hub_disconnection: {
|
|
15249
|
+
description: 'Indicates whether the hub supports simulating disconnection in a sandbox.',
|
|
15250
|
+
type: 'boolean',
|
|
15251
|
+
},
|
|
15252
|
+
can_simulate_paid_subscription: {
|
|
15253
|
+
description: 'Indicates whether the device supports simulating a paid subscription in a sandbox.',
|
|
15254
|
+
type: 'boolean',
|
|
15255
|
+
},
|
|
15256
|
+
can_simulate_removal: {
|
|
15257
|
+
description: 'Indicates whether the device supports simulating removal in a sandbox.',
|
|
15258
|
+
type: 'boolean',
|
|
15259
|
+
},
|
|
15260
|
+
can_turn_off_hvac: {
|
|
15261
|
+
description: 'Indicates whether the thermostat can be turned off.',
|
|
15262
|
+
type: 'boolean',
|
|
15263
|
+
},
|
|
15264
|
+
can_unlock_with_code: {
|
|
15265
|
+
description: 'Indicates whether the lock supports unlocking with an access code.',
|
|
15079
15266
|
type: 'boolean',
|
|
15080
15267
|
},
|
|
15081
|
-
can_remotely_lock: { type: 'boolean' },
|
|
15082
|
-
can_remotely_unlock: { type: 'boolean' },
|
|
15083
|
-
can_run_thermostat_programs: { type: 'boolean' },
|
|
15084
|
-
can_simulate_connection: { type: 'boolean' },
|
|
15085
|
-
can_simulate_disconnection: { type: 'boolean' },
|
|
15086
|
-
can_simulate_hub_connection: { type: 'boolean' },
|
|
15087
|
-
can_simulate_hub_disconnection: { type: 'boolean' },
|
|
15088
|
-
can_simulate_paid_subscription: { type: 'boolean' },
|
|
15089
|
-
can_simulate_removal: { type: 'boolean' },
|
|
15090
|
-
can_turn_off_hvac: { type: 'boolean' },
|
|
15091
|
-
can_unlock_with_code: { type: 'boolean' },
|
|
15092
15268
|
device_provider_name: {
|
|
15269
|
+
description: 'Name of the device provider.',
|
|
15093
15270
|
enum: [
|
|
15094
15271
|
'hotek',
|
|
15095
15272
|
'dormakaba_community',
|
|
@@ -15154,9 +15331,16 @@ const openapi = {
|
|
|
15154
15331
|
],
|
|
15155
15332
|
type: 'string',
|
|
15156
15333
|
},
|
|
15157
|
-
display_name: {
|
|
15158
|
-
|
|
15334
|
+
display_name: {
|
|
15335
|
+
description: 'Display name for the device provider.',
|
|
15336
|
+
type: 'string',
|
|
15337
|
+
},
|
|
15338
|
+
image_url: {
|
|
15339
|
+
description: 'Image URL for the device provider.',
|
|
15340
|
+
type: 'string',
|
|
15341
|
+
},
|
|
15159
15342
|
provider_categories: {
|
|
15343
|
+
description: 'List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.',
|
|
15160
15344
|
items: {
|
|
15161
15345
|
enum: [
|
|
15162
15346
|
'stable',
|
|
@@ -15308,6 +15492,7 @@ const openapi = {
|
|
|
15308
15492
|
changed_properties: {
|
|
15309
15493
|
description: 'List of properties that changed on the access code.',
|
|
15310
15494
|
items: {
|
|
15495
|
+
description: 'Record describing a single changed property.',
|
|
15311
15496
|
properties: {
|
|
15312
15497
|
from: {
|
|
15313
15498
|
description: 'Previous value of the property, or null if not set.',
|
|
@@ -15927,6 +16112,7 @@ const openapi = {
|
|
|
15927
16112
|
access_code_errors: {
|
|
15928
16113
|
description: 'Errors associated with the access code.',
|
|
15929
16114
|
items: {
|
|
16115
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
15930
16116
|
properties: {
|
|
15931
16117
|
created_at: {
|
|
15932
16118
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -15955,6 +16141,7 @@ const openapi = {
|
|
|
15955
16141
|
access_code_warnings: {
|
|
15956
16142
|
description: 'Warnings associated with the access code.',
|
|
15957
16143
|
items: {
|
|
16144
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
15958
16145
|
properties: {
|
|
15959
16146
|
created_at: {
|
|
15960
16147
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -15985,6 +16172,7 @@ const openapi = {
|
|
|
15985
16172
|
connected_account_errors: {
|
|
15986
16173
|
description: 'Errors associated with the connected account.',
|
|
15987
16174
|
items: {
|
|
16175
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
15988
16176
|
properties: {
|
|
15989
16177
|
created_at: {
|
|
15990
16178
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16013,6 +16201,7 @@ const openapi = {
|
|
|
16013
16201
|
connected_account_warnings: {
|
|
16014
16202
|
description: 'Warnings associated with the connected account.',
|
|
16015
16203
|
items: {
|
|
16204
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16016
16205
|
properties: {
|
|
16017
16206
|
created_at: {
|
|
16018
16207
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16048,6 +16237,7 @@ const openapi = {
|
|
|
16048
16237
|
device_errors: {
|
|
16049
16238
|
description: 'Errors associated with the device.',
|
|
16050
16239
|
items: {
|
|
16240
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16051
16241
|
properties: {
|
|
16052
16242
|
created_at: {
|
|
16053
16243
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16076,6 +16266,7 @@ const openapi = {
|
|
|
16076
16266
|
device_warnings: {
|
|
16077
16267
|
description: 'Warnings associated with the device.',
|
|
16078
16268
|
items: {
|
|
16269
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16079
16270
|
properties: {
|
|
16080
16271
|
created_at: {
|
|
16081
16272
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16141,6 +16332,7 @@ const openapi = {
|
|
|
16141
16332
|
access_code_errors: {
|
|
16142
16333
|
description: 'Errors associated with the access code.',
|
|
16143
16334
|
items: {
|
|
16335
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16144
16336
|
properties: {
|
|
16145
16337
|
created_at: {
|
|
16146
16338
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16169,6 +16361,7 @@ const openapi = {
|
|
|
16169
16361
|
access_code_warnings: {
|
|
16170
16362
|
description: 'Warnings associated with the access code.',
|
|
16171
16363
|
items: {
|
|
16364
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16172
16365
|
properties: {
|
|
16173
16366
|
created_at: {
|
|
16174
16367
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16199,6 +16392,7 @@ const openapi = {
|
|
|
16199
16392
|
connected_account_errors: {
|
|
16200
16393
|
description: 'Errors associated with the connected account.',
|
|
16201
16394
|
items: {
|
|
16395
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16202
16396
|
properties: {
|
|
16203
16397
|
created_at: {
|
|
16204
16398
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16227,6 +16421,7 @@ const openapi = {
|
|
|
16227
16421
|
connected_account_warnings: {
|
|
16228
16422
|
description: 'Warnings associated with the connected account.',
|
|
16229
16423
|
items: {
|
|
16424
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16230
16425
|
properties: {
|
|
16231
16426
|
created_at: {
|
|
16232
16427
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16262,6 +16457,7 @@ const openapi = {
|
|
|
16262
16457
|
device_errors: {
|
|
16263
16458
|
description: 'Errors associated with the device.',
|
|
16264
16459
|
items: {
|
|
16460
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16265
16461
|
properties: {
|
|
16266
16462
|
created_at: {
|
|
16267
16463
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16290,6 +16486,7 @@ const openapi = {
|
|
|
16290
16486
|
device_warnings: {
|
|
16291
16487
|
description: 'Warnings associated with the device.',
|
|
16292
16488
|
items: {
|
|
16489
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16293
16490
|
properties: {
|
|
16294
16491
|
created_at: {
|
|
16295
16492
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16428,6 +16625,7 @@ const openapi = {
|
|
|
16428
16625
|
access_code_errors: {
|
|
16429
16626
|
description: 'Errors associated with the access code.',
|
|
16430
16627
|
items: {
|
|
16628
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16431
16629
|
properties: {
|
|
16432
16630
|
created_at: {
|
|
16433
16631
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16456,6 +16654,7 @@ const openapi = {
|
|
|
16456
16654
|
access_code_warnings: {
|
|
16457
16655
|
description: 'Warnings associated with the access code.',
|
|
16458
16656
|
items: {
|
|
16657
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16459
16658
|
properties: {
|
|
16460
16659
|
created_at: {
|
|
16461
16660
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16486,6 +16685,7 @@ const openapi = {
|
|
|
16486
16685
|
connected_account_errors: {
|
|
16487
16686
|
description: 'Errors associated with the connected account.',
|
|
16488
16687
|
items: {
|
|
16688
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16489
16689
|
properties: {
|
|
16490
16690
|
created_at: {
|
|
16491
16691
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16514,6 +16714,7 @@ const openapi = {
|
|
|
16514
16714
|
connected_account_warnings: {
|
|
16515
16715
|
description: 'Warnings associated with the connected account.',
|
|
16516
16716
|
items: {
|
|
16717
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16517
16718
|
properties: {
|
|
16518
16719
|
created_at: {
|
|
16519
16720
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16549,6 +16750,7 @@ const openapi = {
|
|
|
16549
16750
|
device_errors: {
|
|
16550
16751
|
description: 'Errors associated with the device.',
|
|
16551
16752
|
items: {
|
|
16753
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16552
16754
|
properties: {
|
|
16553
16755
|
created_at: {
|
|
16554
16756
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16577,6 +16779,7 @@ const openapi = {
|
|
|
16577
16779
|
device_warnings: {
|
|
16578
16780
|
description: 'Warnings associated with the device.',
|
|
16579
16781
|
items: {
|
|
16782
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16580
16783
|
properties: {
|
|
16581
16784
|
created_at: {
|
|
16582
16785
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16642,6 +16845,7 @@ const openapi = {
|
|
|
16642
16845
|
access_code_errors: {
|
|
16643
16846
|
description: 'Errors associated with the access code.',
|
|
16644
16847
|
items: {
|
|
16848
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16645
16849
|
properties: {
|
|
16646
16850
|
created_at: {
|
|
16647
16851
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16670,6 +16874,7 @@ const openapi = {
|
|
|
16670
16874
|
access_code_warnings: {
|
|
16671
16875
|
description: 'Warnings associated with the access code.',
|
|
16672
16876
|
items: {
|
|
16877
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16673
16878
|
properties: {
|
|
16674
16879
|
created_at: {
|
|
16675
16880
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16700,6 +16905,7 @@ const openapi = {
|
|
|
16700
16905
|
connected_account_errors: {
|
|
16701
16906
|
description: 'Errors associated with the connected account.',
|
|
16702
16907
|
items: {
|
|
16908
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16703
16909
|
properties: {
|
|
16704
16910
|
created_at: {
|
|
16705
16911
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16728,6 +16934,7 @@ const openapi = {
|
|
|
16728
16934
|
connected_account_warnings: {
|
|
16729
16935
|
description: 'Warnings associated with the connected account.',
|
|
16730
16936
|
items: {
|
|
16937
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16731
16938
|
properties: {
|
|
16732
16939
|
created_at: {
|
|
16733
16940
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16763,6 +16970,7 @@ const openapi = {
|
|
|
16763
16970
|
device_errors: {
|
|
16764
16971
|
description: 'Errors associated with the device.',
|
|
16765
16972
|
items: {
|
|
16973
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
16766
16974
|
properties: {
|
|
16767
16975
|
created_at: {
|
|
16768
16976
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -16791,6 +16999,7 @@ const openapi = {
|
|
|
16791
16999
|
device_warnings: {
|
|
16792
17000
|
description: 'Warnings associated with the device.',
|
|
16793
17001
|
items: {
|
|
17002
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
16794
17003
|
properties: {
|
|
16795
17004
|
created_at: {
|
|
16796
17005
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -16998,7 +17207,10 @@ const openapi = {
|
|
|
16998
17207
|
format: 'uuid',
|
|
16999
17208
|
type: 'string',
|
|
17000
17209
|
},
|
|
17001
|
-
backup_access_code_id: {
|
|
17210
|
+
backup_access_code_id: {
|
|
17211
|
+
description: 'ID of the backup access code that was pulled from the pool.',
|
|
17212
|
+
type: 'string',
|
|
17213
|
+
},
|
|
17002
17214
|
connected_account_custom_metadata: {
|
|
17003
17215
|
additionalProperties: {
|
|
17004
17216
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
@@ -17138,6 +17350,7 @@ const openapi = {
|
|
|
17138
17350
|
access_code_errors: {
|
|
17139
17351
|
description: 'Errors associated with the access code.',
|
|
17140
17352
|
items: {
|
|
17353
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17141
17354
|
properties: {
|
|
17142
17355
|
created_at: {
|
|
17143
17356
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -17166,6 +17379,7 @@ const openapi = {
|
|
|
17166
17379
|
access_code_warnings: {
|
|
17167
17380
|
description: 'Warnings associated with the access code.',
|
|
17168
17381
|
items: {
|
|
17382
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
17169
17383
|
properties: {
|
|
17170
17384
|
created_at: {
|
|
17171
17385
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -17196,6 +17410,7 @@ const openapi = {
|
|
|
17196
17410
|
connected_account_errors: {
|
|
17197
17411
|
description: 'Errors associated with the connected account.',
|
|
17198
17412
|
items: {
|
|
17413
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17199
17414
|
properties: {
|
|
17200
17415
|
created_at: {
|
|
17201
17416
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -17224,6 +17439,7 @@ const openapi = {
|
|
|
17224
17439
|
connected_account_warnings: {
|
|
17225
17440
|
description: 'Warnings associated with the connected account.',
|
|
17226
17441
|
items: {
|
|
17442
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
17227
17443
|
properties: {
|
|
17228
17444
|
created_at: {
|
|
17229
17445
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -17259,6 +17475,7 @@ const openapi = {
|
|
|
17259
17475
|
device_errors: {
|
|
17260
17476
|
description: 'Errors associated with the device.',
|
|
17261
17477
|
items: {
|
|
17478
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17262
17479
|
properties: {
|
|
17263
17480
|
created_at: {
|
|
17264
17481
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -17287,6 +17504,7 @@ const openapi = {
|
|
|
17287
17504
|
device_warnings: {
|
|
17288
17505
|
description: 'Warnings associated with the device.',
|
|
17289
17506
|
items: {
|
|
17507
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
17290
17508
|
properties: {
|
|
17291
17509
|
created_at: {
|
|
17292
17510
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -18253,6 +18471,7 @@ const openapi = {
|
|
|
18253
18471
|
acs_system_errors: {
|
|
18254
18472
|
description: 'Errors associated with the access control system.',
|
|
18255
18473
|
items: {
|
|
18474
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18256
18475
|
properties: {
|
|
18257
18476
|
created_at: {
|
|
18258
18477
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -18281,6 +18500,7 @@ const openapi = {
|
|
|
18281
18500
|
acs_system_warnings: {
|
|
18282
18501
|
description: 'Warnings associated with the access control system.',
|
|
18283
18502
|
items: {
|
|
18503
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18284
18504
|
properties: {
|
|
18285
18505
|
created_at: {
|
|
18286
18506
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -18304,6 +18524,7 @@ const openapi = {
|
|
|
18304
18524
|
connected_account_errors: {
|
|
18305
18525
|
description: 'Errors associated with the connected account.',
|
|
18306
18526
|
items: {
|
|
18527
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18307
18528
|
properties: {
|
|
18308
18529
|
created_at: {
|
|
18309
18530
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -18332,6 +18553,7 @@ const openapi = {
|
|
|
18332
18553
|
connected_account_warnings: {
|
|
18333
18554
|
description: 'Warnings associated with the connected account.',
|
|
18334
18555
|
items: {
|
|
18556
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18335
18557
|
properties: {
|
|
18336
18558
|
created_at: {
|
|
18337
18559
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -18608,7 +18830,11 @@ const openapi = {
|
|
|
18608
18830
|
format: 'uuid',
|
|
18609
18831
|
type: 'string',
|
|
18610
18832
|
},
|
|
18611
|
-
acs_user_id: {
|
|
18833
|
+
acs_user_id: {
|
|
18834
|
+
description: 'ID of the affected access system user.',
|
|
18835
|
+
format: 'uuid',
|
|
18836
|
+
type: 'string',
|
|
18837
|
+
},
|
|
18612
18838
|
connected_account_id: {
|
|
18613
18839
|
description: 'ID of the connected account.',
|
|
18614
18840
|
format: 'uuid',
|
|
@@ -18656,7 +18882,11 @@ const openapi = {
|
|
|
18656
18882
|
format: 'uuid',
|
|
18657
18883
|
type: 'string',
|
|
18658
18884
|
},
|
|
18659
|
-
acs_user_id: {
|
|
18885
|
+
acs_user_id: {
|
|
18886
|
+
description: 'ID of the affected access system user.',
|
|
18887
|
+
format: 'uuid',
|
|
18888
|
+
type: 'string',
|
|
18889
|
+
},
|
|
18660
18890
|
connected_account_id: {
|
|
18661
18891
|
description: 'ID of the connected account.',
|
|
18662
18892
|
format: 'uuid',
|
|
@@ -18858,7 +19088,11 @@ const openapi = {
|
|
|
18858
19088
|
{
|
|
18859
19089
|
description: 'An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was added.',
|
|
18860
19090
|
properties: {
|
|
18861
|
-
acs_entrance_id: {
|
|
19091
|
+
acs_entrance_id: {
|
|
19092
|
+
description: 'ID of the affected entrance.',
|
|
19093
|
+
format: 'uuid',
|
|
19094
|
+
type: 'string',
|
|
19095
|
+
},
|
|
18862
19096
|
acs_system_id: {
|
|
18863
19097
|
description: 'ID of the access system.',
|
|
18864
19098
|
format: 'uuid',
|
|
@@ -18906,7 +19140,11 @@ const openapi = {
|
|
|
18906
19140
|
{
|
|
18907
19141
|
description: 'An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was removed.',
|
|
18908
19142
|
properties: {
|
|
18909
|
-
acs_entrance_id: {
|
|
19143
|
+
acs_entrance_id: {
|
|
19144
|
+
description: 'ID of the affected entrance.',
|
|
19145
|
+
format: 'uuid',
|
|
19146
|
+
type: 'string',
|
|
19147
|
+
},
|
|
18910
19148
|
acs_system_id: {
|
|
18911
19149
|
description: 'ID of the access system.',
|
|
18912
19150
|
format: 'uuid',
|
|
@@ -19181,6 +19419,7 @@ const openapi = {
|
|
|
19181
19419
|
connected_account_errors: {
|
|
19182
19420
|
description: 'Errors associated with the connected account.',
|
|
19183
19421
|
items: {
|
|
19422
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
19184
19423
|
properties: {
|
|
19185
19424
|
created_at: {
|
|
19186
19425
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -19209,6 +19448,7 @@ const openapi = {
|
|
|
19209
19448
|
connected_account_warnings: {
|
|
19210
19449
|
description: 'Warnings associated with the connected account.',
|
|
19211
19450
|
items: {
|
|
19451
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
19212
19452
|
properties: {
|
|
19213
19453
|
created_at: {
|
|
19214
19454
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -19443,6 +19683,7 @@ const openapi = {
|
|
|
19443
19683
|
connected_account_errors: {
|
|
19444
19684
|
description: 'Errors associated with the connected account.',
|
|
19445
19685
|
items: {
|
|
19686
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
19446
19687
|
properties: {
|
|
19447
19688
|
created_at: {
|
|
19448
19689
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -19471,6 +19712,7 @@ const openapi = {
|
|
|
19471
19712
|
connected_account_warnings: {
|
|
19472
19713
|
description: 'Warnings associated with the connected account.',
|
|
19473
19714
|
items: {
|
|
19715
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
19474
19716
|
properties: {
|
|
19475
19717
|
created_at: {
|
|
19476
19718
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -20471,6 +20713,7 @@ const openapi = {
|
|
|
20471
20713
|
connected_account_errors: {
|
|
20472
20714
|
description: 'Errors associated with the connected account.',
|
|
20473
20715
|
items: {
|
|
20716
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
20474
20717
|
properties: {
|
|
20475
20718
|
created_at: {
|
|
20476
20719
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -20499,6 +20742,7 @@ const openapi = {
|
|
|
20499
20742
|
connected_account_warnings: {
|
|
20500
20743
|
description: 'Warnings associated with the connected account.',
|
|
20501
20744
|
items: {
|
|
20745
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
20502
20746
|
properties: {
|
|
20503
20747
|
created_at: {
|
|
20504
20748
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -20538,6 +20782,7 @@ const openapi = {
|
|
|
20538
20782
|
device_errors: {
|
|
20539
20783
|
description: 'Errors associated with the device.',
|
|
20540
20784
|
items: {
|
|
20785
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
20541
20786
|
properties: {
|
|
20542
20787
|
created_at: {
|
|
20543
20788
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -20566,6 +20811,7 @@ const openapi = {
|
|
|
20566
20811
|
device_warnings: {
|
|
20567
20812
|
description: 'Warnings associated with the device.',
|
|
20568
20813
|
items: {
|
|
20814
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
20569
20815
|
properties: {
|
|
20570
20816
|
created_at: {
|
|
20571
20817
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -20642,6 +20888,7 @@ const openapi = {
|
|
|
20642
20888
|
connected_account_errors: {
|
|
20643
20889
|
description: 'Errors associated with the connected account.',
|
|
20644
20890
|
items: {
|
|
20891
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
20645
20892
|
properties: {
|
|
20646
20893
|
created_at: {
|
|
20647
20894
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -20670,6 +20917,7 @@ const openapi = {
|
|
|
20670
20917
|
connected_account_warnings: {
|
|
20671
20918
|
description: 'Warnings associated with the connected account.',
|
|
20672
20919
|
items: {
|
|
20920
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
20673
20921
|
properties: {
|
|
20674
20922
|
created_at: {
|
|
20675
20923
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -20709,6 +20957,7 @@ const openapi = {
|
|
|
20709
20957
|
device_errors: {
|
|
20710
20958
|
description: 'Errors associated with the device.',
|
|
20711
20959
|
items: {
|
|
20960
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
20712
20961
|
properties: {
|
|
20713
20962
|
created_at: {
|
|
20714
20963
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -20737,6 +20986,7 @@ const openapi = {
|
|
|
20737
20986
|
device_warnings: {
|
|
20738
20987
|
description: 'Warnings associated with the device.',
|
|
20739
20988
|
items: {
|
|
20989
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
20740
20990
|
properties: {
|
|
20741
20991
|
created_at: {
|
|
20742
20992
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -21443,6 +21693,7 @@ const openapi = {
|
|
|
21443
21693
|
connected_account_errors: {
|
|
21444
21694
|
description: 'Errors associated with the connected account.',
|
|
21445
21695
|
items: {
|
|
21696
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
21446
21697
|
properties: {
|
|
21447
21698
|
created_at: {
|
|
21448
21699
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -21471,6 +21722,7 @@ const openapi = {
|
|
|
21471
21722
|
connected_account_warnings: {
|
|
21472
21723
|
description: 'Warnings associated with the connected account.',
|
|
21473
21724
|
items: {
|
|
21725
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
21474
21726
|
properties: {
|
|
21475
21727
|
created_at: {
|
|
21476
21728
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -21510,6 +21762,7 @@ const openapi = {
|
|
|
21510
21762
|
device_errors: {
|
|
21511
21763
|
description: 'Errors associated with the device.',
|
|
21512
21764
|
items: {
|
|
21765
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
21513
21766
|
properties: {
|
|
21514
21767
|
created_at: {
|
|
21515
21768
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -21538,6 +21791,7 @@ const openapi = {
|
|
|
21538
21791
|
device_warnings: {
|
|
21539
21792
|
description: 'Warnings associated with the device.',
|
|
21540
21793
|
items: {
|
|
21794
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
21541
21795
|
properties: {
|
|
21542
21796
|
created_at: {
|
|
21543
21797
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -21675,6 +21929,7 @@ const openapi = {
|
|
|
21675
21929
|
connected_account_errors: {
|
|
21676
21930
|
description: 'Errors associated with the connected account.',
|
|
21677
21931
|
items: {
|
|
21932
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
21678
21933
|
properties: {
|
|
21679
21934
|
created_at: {
|
|
21680
21935
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -21703,6 +21958,7 @@ const openapi = {
|
|
|
21703
21958
|
connected_account_warnings: {
|
|
21704
21959
|
description: 'Warnings associated with the connected account.',
|
|
21705
21960
|
items: {
|
|
21961
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
21706
21962
|
properties: {
|
|
21707
21963
|
created_at: {
|
|
21708
21964
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -21742,6 +21998,7 @@ const openapi = {
|
|
|
21742
21998
|
device_errors: {
|
|
21743
21999
|
description: 'Errors associated with the device.',
|
|
21744
22000
|
items: {
|
|
22001
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
21745
22002
|
properties: {
|
|
21746
22003
|
created_at: {
|
|
21747
22004
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -21770,6 +22027,7 @@ const openapi = {
|
|
|
21770
22027
|
device_warnings: {
|
|
21771
22028
|
description: 'Warnings associated with the device.',
|
|
21772
22029
|
items: {
|
|
22030
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
21773
22031
|
properties: {
|
|
21774
22032
|
created_at: {
|
|
21775
22033
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -21975,6 +22233,7 @@ const openapi = {
|
|
|
21975
22233
|
connected_account_errors: {
|
|
21976
22234
|
description: 'Errors associated with the connected account.',
|
|
21977
22235
|
items: {
|
|
22236
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
21978
22237
|
properties: {
|
|
21979
22238
|
created_at: {
|
|
21980
22239
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -22003,6 +22262,7 @@ const openapi = {
|
|
|
22003
22262
|
connected_account_warnings: {
|
|
22004
22263
|
description: 'Warnings associated with the connected account.',
|
|
22005
22264
|
items: {
|
|
22265
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
22006
22266
|
properties: {
|
|
22007
22267
|
created_at: {
|
|
22008
22268
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -22042,6 +22302,7 @@ const openapi = {
|
|
|
22042
22302
|
device_errors: {
|
|
22043
22303
|
description: 'Errors associated with the device.',
|
|
22044
22304
|
items: {
|
|
22305
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
22045
22306
|
properties: {
|
|
22046
22307
|
created_at: {
|
|
22047
22308
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -22070,6 +22331,7 @@ const openapi = {
|
|
|
22070
22331
|
device_warnings: {
|
|
22071
22332
|
description: 'Warnings associated with the device.',
|
|
22072
22333
|
items: {
|
|
22334
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
22073
22335
|
properties: {
|
|
22074
22336
|
created_at: {
|
|
22075
22337
|
description: 'Date and time at which Seam created the warning.',
|
|
@@ -22436,6 +22698,21 @@ const openapi = {
|
|
|
22436
22698
|
format: 'uuid',
|
|
22437
22699
|
type: 'string',
|
|
22438
22700
|
},
|
|
22701
|
+
acs_entrance_id: {
|
|
22702
|
+
description: '\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the access-denied event.\n ',
|
|
22703
|
+
format: 'uuid',
|
|
22704
|
+
type: 'string',
|
|
22705
|
+
},
|
|
22706
|
+
acs_system_id: {
|
|
22707
|
+
description: '\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the access-denied event.\n ',
|
|
22708
|
+
format: 'uuid',
|
|
22709
|
+
type: 'string',
|
|
22710
|
+
},
|
|
22711
|
+
acs_user_id: {
|
|
22712
|
+
description: '\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the access-denied event.\n ',
|
|
22713
|
+
format: 'uuid',
|
|
22714
|
+
type: 'string',
|
|
22715
|
+
},
|
|
22439
22716
|
connected_account_custom_metadata: {
|
|
22440
22717
|
additionalProperties: {
|
|
22441
22718
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
@@ -22480,6 +22757,11 @@ const openapi = {
|
|
|
22480
22757
|
format: 'date-time',
|
|
22481
22758
|
type: 'string',
|
|
22482
22759
|
},
|
|
22760
|
+
user_identity_id: {
|
|
22761
|
+
description: '\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the access-denied event.\n ',
|
|
22762
|
+
format: 'uuid',
|
|
22763
|
+
type: 'string',
|
|
22764
|
+
},
|
|
22483
22765
|
workspace_id: {
|
|
22484
22766
|
description: 'ID of the workspace associated with the event.',
|
|
22485
22767
|
format: 'uuid',
|
|
@@ -22491,7 +22773,6 @@ const openapi = {
|
|
|
22491
22773
|
'workspace_id',
|
|
22492
22774
|
'created_at',
|
|
22493
22775
|
'occurred_at',
|
|
22494
|
-
'device_id',
|
|
22495
22776
|
'connected_account_id',
|
|
22496
22777
|
'event_type',
|
|
22497
22778
|
],
|
|
@@ -23783,7 +24064,7 @@ const openapi = {
|
|
|
23783
24064
|
type: 'string',
|
|
23784
24065
|
},
|
|
23785
24066
|
device_type: {
|
|
23786
|
-
description: '
|
|
24067
|
+
description: 'Type of the phone device, such as `ios_phone` or `android_phone`.',
|
|
23787
24068
|
enum: ['ios_phone', 'android_phone'],
|
|
23788
24069
|
type: 'string',
|
|
23789
24070
|
},
|
|
@@ -23795,8 +24076,14 @@ const openapi = {
|
|
|
23795
24076
|
description: 'Errors associated with the phone.',
|
|
23796
24077
|
items: {
|
|
23797
24078
|
properties: {
|
|
23798
|
-
error_code: {
|
|
23799
|
-
|
|
24079
|
+
error_code: {
|
|
24080
|
+
description: 'Unique identifier of the type of error.',
|
|
24081
|
+
type: 'string',
|
|
24082
|
+
},
|
|
24083
|
+
message: {
|
|
24084
|
+
description: 'Detailed description of the error.',
|
|
24085
|
+
type: 'string',
|
|
24086
|
+
},
|
|
23800
24087
|
},
|
|
23801
24088
|
required: ['error_code', 'message'],
|
|
23802
24089
|
type: 'object',
|
|
@@ -23808,7 +24095,7 @@ const openapi = {
|
|
|
23808
24095
|
type: 'string',
|
|
23809
24096
|
},
|
|
23810
24097
|
properties: {
|
|
23811
|
-
description: '
|
|
24098
|
+
description: 'Properties of the phone.',
|
|
23812
24099
|
properties: {
|
|
23813
24100
|
assa_abloy_credential_service_metadata: {
|
|
23814
24101
|
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
@@ -23857,8 +24144,14 @@ const openapi = {
|
|
|
23857
24144
|
description: 'Warnings associated with the phone.',
|
|
23858
24145
|
items: {
|
|
23859
24146
|
properties: {
|
|
23860
|
-
message: {
|
|
23861
|
-
|
|
24147
|
+
message: {
|
|
24148
|
+
description: 'Detailed description of the warning.',
|
|
24149
|
+
type: 'string',
|
|
24150
|
+
},
|
|
24151
|
+
warning_code: {
|
|
24152
|
+
description: 'Unique identifier of the type of warning.',
|
|
24153
|
+
type: 'string',
|
|
24154
|
+
},
|
|
23862
24155
|
},
|
|
23863
24156
|
required: ['warning_code', 'message'],
|
|
23864
24157
|
type: 'object',
|
|
@@ -23937,6 +24230,7 @@ const openapi = {
|
|
|
23937
24230
|
},
|
|
23938
24231
|
acs_credential_id: { nullable: true, type: 'string' },
|
|
23939
24232
|
acs_credential_pool_id: {
|
|
24233
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
23940
24234
|
format: 'uuid',
|
|
23941
24235
|
type: 'string',
|
|
23942
24236
|
},
|
|
@@ -24547,7 +24841,11 @@ const openapi = {
|
|
|
24547
24841
|
nullable: true,
|
|
24548
24842
|
type: 'boolean',
|
|
24549
24843
|
},
|
|
24550
|
-
is_managed: {
|
|
24844
|
+
is_managed: {
|
|
24845
|
+
description: 'Indicates whether Seam manages the credential.',
|
|
24846
|
+
enum: [true],
|
|
24847
|
+
type: 'boolean',
|
|
24848
|
+
},
|
|
24551
24849
|
is_multi_phone_sync_credential: {
|
|
24552
24850
|
description: '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).',
|
|
24553
24851
|
type: 'boolean',
|
|
@@ -24857,7 +25155,11 @@ const openapi = {
|
|
|
24857
25155
|
format: 'date-time',
|
|
24858
25156
|
type: 'string',
|
|
24859
25157
|
},
|
|
24860
|
-
display_name: {
|
|
25158
|
+
display_name: {
|
|
25159
|
+
description: 'Display name for the user identity.',
|
|
25160
|
+
minLength: 1,
|
|
25161
|
+
type: 'string',
|
|
25162
|
+
},
|
|
24861
25163
|
email_address: {
|
|
24862
25164
|
description: 'Unique email address for the user identity.',
|
|
24863
25165
|
format: 'email',
|
|
@@ -24911,7 +25213,12 @@ const openapi = {
|
|
|
24911
25213
|
},
|
|
24912
25214
|
type: 'array',
|
|
24913
25215
|
},
|
|
24914
|
-
full_name: {
|
|
25216
|
+
full_name: {
|
|
25217
|
+
description: 'Full name of the user associated with the user identity.',
|
|
25218
|
+
minLength: 1,
|
|
25219
|
+
nullable: true,
|
|
25220
|
+
type: 'string',
|
|
25221
|
+
},
|
|
24915
25222
|
phone_number: {
|
|
24916
25223
|
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).',
|
|
24917
25224
|
nullable: true,
|
|
@@ -26725,7 +27032,10 @@ const openapi = {
|
|
|
26725
27032
|
format: 'date-time',
|
|
26726
27033
|
type: 'string',
|
|
26727
27034
|
},
|
|
26728
|
-
display_name: {
|
|
27035
|
+
display_name: {
|
|
27036
|
+
description: 'Display name for the access group.',
|
|
27037
|
+
type: 'string',
|
|
27038
|
+
},
|
|
26729
27039
|
errors: {
|
|
26730
27040
|
description: 'Errors associated with the `acs_access_group`.',
|
|
26731
27041
|
items: {
|
|
@@ -27197,7 +27507,11 @@ const openapi = {
|
|
|
27197
27507
|
format: 'uuid',
|
|
27198
27508
|
type: 'string',
|
|
27199
27509
|
},
|
|
27200
|
-
acs_credential_pool_id: {
|
|
27510
|
+
acs_credential_pool_id: {
|
|
27511
|
+
description: 'ID of the credential pool to which the credential belongs.',
|
|
27512
|
+
format: 'uuid',
|
|
27513
|
+
type: 'string',
|
|
27514
|
+
},
|
|
27201
27515
|
acs_system_id: {
|
|
27202
27516
|
description: '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).',
|
|
27203
27517
|
format: 'uuid',
|
|
@@ -27757,7 +28071,11 @@ const openapi = {
|
|
|
27757
28071
|
minLength: 1,
|
|
27758
28072
|
type: 'string',
|
|
27759
28073
|
},
|
|
27760
|
-
hid_acs_system_id: {
|
|
28074
|
+
hid_acs_system_id: {
|
|
28075
|
+
description: 'ID of the HID access control system associated with the user.',
|
|
28076
|
+
format: 'uuid',
|
|
28077
|
+
type: 'string',
|
|
28078
|
+
},
|
|
27761
28079
|
is_managed: { enum: [false], type: 'boolean' },
|
|
27762
28080
|
is_suspended: {
|
|
27763
28081
|
description: '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).',
|
|
@@ -28314,30 +28632,86 @@ const openapi = {
|
|
|
28314
28632
|
unmanaged_device: {
|
|
28315
28633
|
description: '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).',
|
|
28316
28634
|
properties: {
|
|
28317
|
-
can_configure_auto_lock: {
|
|
28318
|
-
|
|
28319
|
-
|
|
28320
|
-
|
|
28321
|
-
|
|
28322
|
-
|
|
28635
|
+
can_configure_auto_lock: {
|
|
28636
|
+
description: 'Indicates whether the lock supports configuring automatic locking.',
|
|
28637
|
+
type: 'boolean',
|
|
28638
|
+
},
|
|
28639
|
+
can_hvac_cool: {
|
|
28640
|
+
description: 'Indicates whether the thermostat supports cooling.',
|
|
28641
|
+
type: 'boolean',
|
|
28642
|
+
},
|
|
28643
|
+
can_hvac_heat: {
|
|
28644
|
+
description: 'Indicates whether the thermostat supports heating.',
|
|
28645
|
+
type: 'boolean',
|
|
28646
|
+
},
|
|
28647
|
+
can_hvac_heat_cool: {
|
|
28648
|
+
description: 'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
28649
|
+
type: 'boolean',
|
|
28650
|
+
},
|
|
28651
|
+
can_program_offline_access_codes: {
|
|
28652
|
+
description: 'Indicates whether the device supports programming offline access codes.',
|
|
28653
|
+
type: 'boolean',
|
|
28654
|
+
},
|
|
28655
|
+
can_program_online_access_codes: {
|
|
28656
|
+
description: 'Indicates whether the device supports programming online access codes.',
|
|
28657
|
+
type: 'boolean',
|
|
28658
|
+
},
|
|
28323
28659
|
can_program_thermostat_programs_as_different_each_day: {
|
|
28660
|
+
description: 'Indicates whether the thermostat supports different climate programs for each day of the week.',
|
|
28661
|
+
type: 'boolean',
|
|
28662
|
+
},
|
|
28663
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
28664
|
+
description: 'Indicates whether the thermostat supports a single climate program applied to every day.',
|
|
28324
28665
|
type: 'boolean',
|
|
28325
28666
|
},
|
|
28326
|
-
can_program_thermostat_programs_as_same_each_day: { type: 'boolean' },
|
|
28327
28667
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
28668
|
+
description: 'Indicates whether the thermostat supports weekday/weekend climate programs.',
|
|
28669
|
+
type: 'boolean',
|
|
28670
|
+
},
|
|
28671
|
+
can_remotely_lock: {
|
|
28672
|
+
description: 'Indicates whether the device supports remote locking.',
|
|
28673
|
+
type: 'boolean',
|
|
28674
|
+
},
|
|
28675
|
+
can_remotely_unlock: {
|
|
28676
|
+
description: 'Indicates whether the device supports remote unlocking.',
|
|
28677
|
+
type: 'boolean',
|
|
28678
|
+
},
|
|
28679
|
+
can_run_thermostat_programs: {
|
|
28680
|
+
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
28681
|
+
type: 'boolean',
|
|
28682
|
+
},
|
|
28683
|
+
can_simulate_connection: {
|
|
28684
|
+
description: 'Indicates whether the device supports simulating connection in a sandbox.',
|
|
28685
|
+
type: 'boolean',
|
|
28686
|
+
},
|
|
28687
|
+
can_simulate_disconnection: {
|
|
28688
|
+
description: 'Indicates whether the device supports simulating disconnection in a sandbox.',
|
|
28689
|
+
type: 'boolean',
|
|
28690
|
+
},
|
|
28691
|
+
can_simulate_hub_connection: {
|
|
28692
|
+
description: 'Indicates whether the hub supports simulating connection in a sandbox.',
|
|
28693
|
+
type: 'boolean',
|
|
28694
|
+
},
|
|
28695
|
+
can_simulate_hub_disconnection: {
|
|
28696
|
+
description: 'Indicates whether the hub supports simulating disconnection in a sandbox.',
|
|
28697
|
+
type: 'boolean',
|
|
28698
|
+
},
|
|
28699
|
+
can_simulate_paid_subscription: {
|
|
28700
|
+
description: 'Indicates whether the device supports simulating a paid subscription in a sandbox.',
|
|
28701
|
+
type: 'boolean',
|
|
28702
|
+
},
|
|
28703
|
+
can_simulate_removal: {
|
|
28704
|
+
description: 'Indicates whether the device supports simulating removal in a sandbox.',
|
|
28705
|
+
type: 'boolean',
|
|
28706
|
+
},
|
|
28707
|
+
can_turn_off_hvac: {
|
|
28708
|
+
description: 'Indicates whether the thermostat can be turned off.',
|
|
28709
|
+
type: 'boolean',
|
|
28710
|
+
},
|
|
28711
|
+
can_unlock_with_code: {
|
|
28712
|
+
description: 'Indicates whether the lock supports unlocking with an access code.',
|
|
28328
28713
|
type: 'boolean',
|
|
28329
28714
|
},
|
|
28330
|
-
can_remotely_lock: { type: 'boolean' },
|
|
28331
|
-
can_remotely_unlock: { type: 'boolean' },
|
|
28332
|
-
can_run_thermostat_programs: { type: 'boolean' },
|
|
28333
|
-
can_simulate_connection: { type: 'boolean' },
|
|
28334
|
-
can_simulate_disconnection: { type: 'boolean' },
|
|
28335
|
-
can_simulate_hub_connection: { type: 'boolean' },
|
|
28336
|
-
can_simulate_hub_disconnection: { type: 'boolean' },
|
|
28337
|
-
can_simulate_paid_subscription: { type: 'boolean' },
|
|
28338
|
-
can_simulate_removal: { type: 'boolean' },
|
|
28339
|
-
can_turn_off_hvac: { type: 'boolean' },
|
|
28340
|
-
can_unlock_with_code: { type: 'boolean' },
|
|
28341
28715
|
capabilities_supported: {
|
|
28342
28716
|
description: '\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 ',
|
|
28343
28717
|
items: {
|
|
@@ -28982,7 +29356,11 @@ const openapi = {
|
|
|
28982
29356
|
thermostats: { name: 'Thermostats' },
|
|
28983
29357
|
},
|
|
28984
29358
|
},
|
|
28985
|
-
is_managed: {
|
|
29359
|
+
is_managed: {
|
|
29360
|
+
description: 'Indicates that Seam does not manage the device.',
|
|
29361
|
+
enum: [false],
|
|
29362
|
+
type: 'boolean',
|
|
29363
|
+
},
|
|
28986
29364
|
location: {
|
|
28987
29365
|
description: 'Location information for the device.',
|
|
28988
29366
|
properties: {
|
|
@@ -29791,7 +30169,11 @@ const openapi = {
|
|
|
29791
30169
|
format: 'date-time',
|
|
29792
30170
|
type: 'string',
|
|
29793
30171
|
},
|
|
29794
|
-
display_name: {
|
|
30172
|
+
display_name: {
|
|
30173
|
+
description: 'Display name for the user identity.',
|
|
30174
|
+
minLength: 1,
|
|
30175
|
+
type: 'string',
|
|
30176
|
+
},
|
|
29795
30177
|
email_address: {
|
|
29796
30178
|
description: 'Unique email address for the user identity.',
|
|
29797
30179
|
format: 'email',
|
|
@@ -29845,7 +30227,12 @@ const openapi = {
|
|
|
29845
30227
|
},
|
|
29846
30228
|
type: 'array',
|
|
29847
30229
|
},
|
|
29848
|
-
full_name: {
|
|
30230
|
+
full_name: {
|
|
30231
|
+
description: 'Full name of the user associated with the user identity.',
|
|
30232
|
+
minLength: 1,
|
|
30233
|
+
nullable: true,
|
|
30234
|
+
type: 'string',
|
|
30235
|
+
},
|
|
29849
30236
|
phone_number: {
|
|
29850
30237
|
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).',
|
|
29851
30238
|
nullable: true,
|
|
@@ -32958,6 +33345,7 @@ const openapi = {
|
|
|
32958
33345
|
type: 'string',
|
|
32959
33346
|
},
|
|
32960
33347
|
full_name: {
|
|
33348
|
+
description: 'Full name of the user associated with the user identity.',
|
|
32961
33349
|
minLength: 1,
|
|
32962
33350
|
nullable: true,
|
|
32963
33351
|
type: 'string',
|
|
@@ -45237,7 +45625,11 @@ const openapi = {
|
|
|
45237
45625
|
minLength: 1,
|
|
45238
45626
|
type: 'string',
|
|
45239
45627
|
},
|
|
45240
|
-
hid_acs_system_id: {
|
|
45628
|
+
hid_acs_system_id: {
|
|
45629
|
+
description: 'ID of the HID access control system associated with the user.',
|
|
45630
|
+
format: 'uuid',
|
|
45631
|
+
type: 'string',
|
|
45632
|
+
},
|
|
45241
45633
|
phone_number: {
|
|
45242
45634
|
description: '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`).',
|
|
45243
45635
|
type: 'string',
|
|
@@ -45333,7 +45725,11 @@ const openapi = {
|
|
|
45333
45725
|
minLength: 1,
|
|
45334
45726
|
type: 'string',
|
|
45335
45727
|
},
|
|
45336
|
-
hid_acs_system_id: {
|
|
45728
|
+
hid_acs_system_id: {
|
|
45729
|
+
description: 'ID of the HID access control system associated with the user.',
|
|
45730
|
+
format: 'uuid',
|
|
45731
|
+
type: 'string',
|
|
45732
|
+
},
|
|
45337
45733
|
phone_number: {
|
|
45338
45734
|
description: '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`).',
|
|
45339
45735
|
type: 'string',
|
|
@@ -75142,6 +75538,7 @@ const openapi = {
|
|
|
75142
75538
|
},
|
|
75143
75539
|
fan_mode: {
|
|
75144
75540
|
deprecated: true,
|
|
75541
|
+
description: 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.',
|
|
75145
75542
|
enum: ['auto', 'on', 'circulate'],
|
|
75146
75543
|
type: 'string',
|
|
75147
75544
|
'x-deprecated': 'Use `fan_mode_setting` instead.',
|
|
@@ -78431,7 +78828,11 @@ const openapi = {
|
|
|
78431
78828
|
format: 'date-time',
|
|
78432
78829
|
type: 'string',
|
|
78433
78830
|
},
|
|
78434
|
-
display_name: {
|
|
78831
|
+
display_name: {
|
|
78832
|
+
description: 'Display name for the user identity.',
|
|
78833
|
+
minLength: 1,
|
|
78834
|
+
type: 'string',
|
|
78835
|
+
},
|
|
78435
78836
|
email_address: {
|
|
78436
78837
|
description: 'Unique email address for the user identity.',
|
|
78437
78838
|
format: 'email',
|
|
@@ -78486,6 +78887,7 @@ const openapi = {
|
|
|
78486
78887
|
type: 'array',
|
|
78487
78888
|
},
|
|
78488
78889
|
full_name: {
|
|
78890
|
+
description: 'Full name of the user associated with the user identity.',
|
|
78489
78891
|
minLength: 1,
|
|
78490
78892
|
nullable: true,
|
|
78491
78893
|
type: 'string',
|
|
@@ -78648,7 +79050,11 @@ const openapi = {
|
|
|
78648
79050
|
format: 'date-time',
|
|
78649
79051
|
type: 'string',
|
|
78650
79052
|
},
|
|
78651
|
-
display_name: {
|
|
79053
|
+
display_name: {
|
|
79054
|
+
description: 'Display name for the user identity.',
|
|
79055
|
+
minLength: 1,
|
|
79056
|
+
type: 'string',
|
|
79057
|
+
},
|
|
78652
79058
|
email_address: {
|
|
78653
79059
|
description: 'Unique email address for the user identity.',
|
|
78654
79060
|
format: 'email',
|
|
@@ -78703,6 +79109,7 @@ const openapi = {
|
|
|
78703
79109
|
type: 'array',
|
|
78704
79110
|
},
|
|
78705
79111
|
full_name: {
|
|
79112
|
+
description: 'Full name of the user associated with the user identity.',
|
|
78706
79113
|
minLength: 1,
|
|
78707
79114
|
nullable: true,
|
|
78708
79115
|
type: 'string',
|
|
@@ -78891,7 +79298,11 @@ const openapi = {
|
|
|
78891
79298
|
format: 'date-time',
|
|
78892
79299
|
type: 'string',
|
|
78893
79300
|
},
|
|
78894
|
-
display_name: {
|
|
79301
|
+
display_name: {
|
|
79302
|
+
description: 'Display name for the user identity.',
|
|
79303
|
+
minLength: 1,
|
|
79304
|
+
type: 'string',
|
|
79305
|
+
},
|
|
78895
79306
|
email_address: {
|
|
78896
79307
|
description: 'Unique email address for the user identity.',
|
|
78897
79308
|
format: 'email',
|
|
@@ -78946,6 +79357,7 @@ const openapi = {
|
|
|
78946
79357
|
type: 'array',
|
|
78947
79358
|
},
|
|
78948
79359
|
full_name: {
|
|
79360
|
+
description: 'Full name of the user associated with the user identity.',
|
|
78949
79361
|
minLength: 1,
|
|
78950
79362
|
nullable: true,
|
|
78951
79363
|
type: 'string',
|
|
@@ -79128,7 +79540,11 @@ const openapi = {
|
|
|
79128
79540
|
format: 'date-time',
|
|
79129
79541
|
type: 'string',
|
|
79130
79542
|
},
|
|
79131
|
-
display_name: {
|
|
79543
|
+
display_name: {
|
|
79544
|
+
description: 'Display name for the user identity.',
|
|
79545
|
+
minLength: 1,
|
|
79546
|
+
type: 'string',
|
|
79547
|
+
},
|
|
79132
79548
|
email_address: {
|
|
79133
79549
|
description: 'Unique email address for the user identity.',
|
|
79134
79550
|
format: 'email',
|
|
@@ -79183,6 +79599,7 @@ const openapi = {
|
|
|
79183
79599
|
type: 'array',
|
|
79184
79600
|
},
|
|
79185
79601
|
full_name: {
|
|
79602
|
+
description: 'Full name of the user associated with the user identity.',
|
|
79186
79603
|
minLength: 1,
|
|
79187
79604
|
nullable: true,
|
|
79188
79605
|
type: 'string',
|