@seamapi/types 1.1102.0 → 1.1104.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/lib/seam/connect/models/access-grants/access-grant.d.ts +37 -21
- package/lib/seam/connect/models/access-grants/access-grant.js +4 -3
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +38 -8
- package/lib/seam/connect/models/acs/acs-entrance.js +22 -9
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +75 -4
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +32 -30
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +395 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +10 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.d.ts +87 -0
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js +37 -0
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js +31 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.d.ts +87 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js +37 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js +31 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js +31 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js.map +1 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -3
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -3
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +95 -1
- package/lib/seam/connect/models/devices/capability-properties/index.js +4 -2
- package/lib/seam/connect/models/devices/capability-properties/index.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/speaker.d.ts +98 -0
- package/lib/seam/connect/models/devices/capability-properties/speaker.js +61 -0
- package/lib/seam/connect/models/devices/capability-properties/speaker.js.map +1 -0
- package/lib/seam/connect/models/devices/device-metadata.d.ts +33 -0
- package/lib/seam/connect/models/devices/device-metadata.js +26 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +12 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +7 -1
- package/lib/seam/connect/models/devices/device-type.js +8 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +200 -3
- package/lib/seam/connect/models/devices/device.js +16 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +1126 -22
- package/lib/seam/connect/models/devices/phone.js +4 -19
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +144 -3
- package/lib/seam/connect/models/phones/phone-session.d.ts +28 -26
- package/lib/seam/connect/models/provider-capability.d.ts +1 -1
- package/lib/seam/connect/models/provider-capability.js +1 -0
- package/lib/seam/connect/models/provider-capability.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +4 -4
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.js +2006 -136
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +8195 -142
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/enums.ts +2 -0
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +13 -5
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +36 -17
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +44 -34
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +10 -0
- package/src/lib/seam/connect/models/action-attempts/pause-speaker-playback.ts +54 -0
- package/src/lib/seam/connect/models/action-attempts/play-speaker-chime.ts +46 -0
- package/src/lib/seam/connect/models/action-attempts/resume-speaker-playback.ts +54 -0
- package/src/lib/seam/connect/models/action-attempts/set-speaker-mute.ts +43 -0
- package/src/lib/seam/connect/models/action-attempts/set-speaker-volume.ts +46 -0
- package/src/lib/seam/connect/models/devices/capability-properties/index.ts +9 -1
- package/src/lib/seam/connect/models/devices/capability-properties/speaker.ts +76 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +29 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-type.ts +16 -0
- package/src/lib/seam/connect/models/devices/device.ts +18 -0
- package/src/lib/seam/connect/models/devices/phone.ts +4 -27
- package/src/lib/seam/connect/models/provider-capability.ts +1 -0
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
- package/src/lib/seam/connect/openapi.ts +2537 -407
- package/src/lib/seam/connect/route-types.ts +9097 -128
|
@@ -1943,7 +1943,8 @@ const openapi = {
|
|
|
1943
1943
|
type: 'string',
|
|
1944
1944
|
},
|
|
1945
1945
|
error_code: {
|
|
1946
|
-
description: 'Reason the access code could not be revoked
|
|
1946
|
+
description: 'Reason the access code could not be revoked.',
|
|
1947
|
+
enum: ['offline_access_code_not_revocable'],
|
|
1947
1948
|
type: 'string',
|
|
1948
1949
|
},
|
|
1949
1950
|
message: {
|
|
@@ -3893,23 +3894,32 @@ const openapi = {
|
|
|
3893
3894
|
errors: {
|
|
3894
3895
|
description: 'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
3895
3896
|
items: {
|
|
3896
|
-
|
|
3897
|
-
|
|
3898
|
-
|
|
3899
|
-
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
|
|
3908
|
-
|
|
3897
|
+
description: 'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
3898
|
+
discriminator: { propertyName: 'error_code' },
|
|
3899
|
+
oneOf: [
|
|
3900
|
+
{
|
|
3901
|
+
description: 'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
|
|
3902
|
+
properties: {
|
|
3903
|
+
created_at: {
|
|
3904
|
+
description: 'Date and time at which Seam created the error.',
|
|
3905
|
+
format: 'date-time',
|
|
3906
|
+
type: 'string',
|
|
3907
|
+
},
|
|
3908
|
+
error_code: {
|
|
3909
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
3910
|
+
enum: ['entrance_removed'],
|
|
3911
|
+
type: 'string',
|
|
3912
|
+
},
|
|
3913
|
+
message: {
|
|
3914
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
3915
|
+
type: 'string',
|
|
3916
|
+
},
|
|
3917
|
+
},
|
|
3918
|
+
required: ['created_at', 'message', 'error_code'],
|
|
3919
|
+
type: 'object',
|
|
3920
|
+
'x-resource-type': 'acs_entrance',
|
|
3909
3921
|
},
|
|
3910
|
-
|
|
3911
|
-
required: ['error_code', 'message', 'created_at'],
|
|
3912
|
-
type: 'object',
|
|
3922
|
+
],
|
|
3913
3923
|
},
|
|
3914
3924
|
type: 'array',
|
|
3915
3925
|
},
|
|
@@ -10313,6 +10323,7 @@ const openapi = {
|
|
|
10313
10323
|
type: 'object',
|
|
10314
10324
|
},
|
|
10315
10325
|
{
|
|
10326
|
+
description: 'Setting the speaker volume is pending.',
|
|
10316
10327
|
properties: {
|
|
10317
10328
|
action_attempt_id: {
|
|
10318
10329
|
description: 'ID of the action attempt.',
|
|
@@ -10320,8 +10331,8 @@ const openapi = {
|
|
|
10320
10331
|
type: 'string',
|
|
10321
10332
|
},
|
|
10322
10333
|
action_type: {
|
|
10323
|
-
description: '
|
|
10324
|
-
enum: ['
|
|
10334
|
+
description: 'Action attempt to track the status of setting the volume on a speaker.',
|
|
10335
|
+
enum: ['SET_SPEAKER_VOLUME'],
|
|
10325
10336
|
type: 'string',
|
|
10326
10337
|
},
|
|
10327
10338
|
error: {
|
|
@@ -10344,6 +10355,7 @@ const openapi = {
|
|
|
10344
10355
|
type: 'object',
|
|
10345
10356
|
},
|
|
10346
10357
|
{
|
|
10358
|
+
description: 'Setting the speaker volume succeeded.',
|
|
10347
10359
|
properties: {
|
|
10348
10360
|
action_attempt_id: {
|
|
10349
10361
|
description: 'ID of the action attempt.',
|
|
@@ -10351,8 +10363,8 @@ const openapi = {
|
|
|
10351
10363
|
type: 'string',
|
|
10352
10364
|
},
|
|
10353
10365
|
action_type: {
|
|
10354
|
-
description: '
|
|
10355
|
-
enum: ['
|
|
10366
|
+
description: 'Action attempt to track the status of setting the volume on a speaker.',
|
|
10367
|
+
enum: ['SET_SPEAKER_VOLUME'],
|
|
10356
10368
|
type: 'string',
|
|
10357
10369
|
},
|
|
10358
10370
|
error: {
|
|
@@ -10376,6 +10388,7 @@ const openapi = {
|
|
|
10376
10388
|
type: 'object',
|
|
10377
10389
|
},
|
|
10378
10390
|
{
|
|
10391
|
+
description: 'Setting the speaker volume failed.',
|
|
10379
10392
|
properties: {
|
|
10380
10393
|
action_attempt_id: {
|
|
10381
10394
|
description: 'ID of the action attempt.',
|
|
@@ -10383,8 +10396,8 @@ const openapi = {
|
|
|
10383
10396
|
type: 'string',
|
|
10384
10397
|
},
|
|
10385
10398
|
action_type: {
|
|
10386
|
-
description: '
|
|
10387
|
-
enum: ['
|
|
10399
|
+
description: 'Action attempt to track the status of setting the volume on a speaker.',
|
|
10400
|
+
enum: ['SET_SPEAKER_VOLUME'],
|
|
10388
10401
|
type: 'string',
|
|
10389
10402
|
},
|
|
10390
10403
|
error: {
|
|
@@ -10415,6 +10428,7 @@ const openapi = {
|
|
|
10415
10428
|
type: 'object',
|
|
10416
10429
|
},
|
|
10417
10430
|
{
|
|
10431
|
+
description: 'Muting or unmuting the speaker is pending.',
|
|
10418
10432
|
properties: {
|
|
10419
10433
|
action_attempt_id: {
|
|
10420
10434
|
description: 'ID of the action attempt.',
|
|
@@ -10422,8 +10436,8 @@ const openapi = {
|
|
|
10422
10436
|
type: 'string',
|
|
10423
10437
|
},
|
|
10424
10438
|
action_type: {
|
|
10425
|
-
description: '
|
|
10426
|
-
enum: ['
|
|
10439
|
+
description: 'Action attempt to track the status of muting or unmuting a speaker.',
|
|
10440
|
+
enum: ['SET_SPEAKER_MUTE'],
|
|
10427
10441
|
type: 'string',
|
|
10428
10442
|
},
|
|
10429
10443
|
error: {
|
|
@@ -10446,6 +10460,7 @@ const openapi = {
|
|
|
10446
10460
|
type: 'object',
|
|
10447
10461
|
},
|
|
10448
10462
|
{
|
|
10463
|
+
description: 'Muting or unmuting the speaker succeeded.',
|
|
10449
10464
|
properties: {
|
|
10450
10465
|
action_attempt_id: {
|
|
10451
10466
|
description: 'ID of the action attempt.',
|
|
@@ -10453,8 +10468,8 @@ const openapi = {
|
|
|
10453
10468
|
type: 'string',
|
|
10454
10469
|
},
|
|
10455
10470
|
action_type: {
|
|
10456
|
-
description: '
|
|
10457
|
-
enum: ['
|
|
10471
|
+
description: 'Action attempt to track the status of muting or unmuting a speaker.',
|
|
10472
|
+
enum: ['SET_SPEAKER_MUTE'],
|
|
10458
10473
|
type: 'string',
|
|
10459
10474
|
},
|
|
10460
10475
|
error: {
|
|
@@ -10463,14 +10478,119 @@ const openapi = {
|
|
|
10463
10478
|
},
|
|
10464
10479
|
result: {
|
|
10465
10480
|
description: 'Result of the action.',
|
|
10481
|
+
properties: {},
|
|
10482
|
+
type: 'object',
|
|
10483
|
+
},
|
|
10484
|
+
status: { enum: ['success'], type: 'string' },
|
|
10485
|
+
},
|
|
10486
|
+
required: [
|
|
10487
|
+
'action_attempt_id',
|
|
10488
|
+
'status',
|
|
10489
|
+
'error',
|
|
10490
|
+
'action_type',
|
|
10491
|
+
'result',
|
|
10492
|
+
],
|
|
10493
|
+
type: 'object',
|
|
10494
|
+
},
|
|
10495
|
+
{
|
|
10496
|
+
description: 'Muting or unmuting the speaker failed.',
|
|
10497
|
+
properties: {
|
|
10498
|
+
action_attempt_id: {
|
|
10499
|
+
description: 'ID of the action attempt.',
|
|
10500
|
+
format: 'uuid',
|
|
10501
|
+
type: 'string',
|
|
10502
|
+
},
|
|
10503
|
+
action_type: {
|
|
10504
|
+
description: 'Action attempt to track the status of muting or unmuting a speaker.',
|
|
10505
|
+
enum: ['SET_SPEAKER_MUTE'],
|
|
10506
|
+
type: 'string',
|
|
10507
|
+
},
|
|
10508
|
+
error: {
|
|
10509
|
+
description: 'Error associated with the action.',
|
|
10466
10510
|
properties: {
|
|
10467
|
-
|
|
10468
|
-
|
|
10469
|
-
|
|
10470
|
-
type: 'object',
|
|
10511
|
+
message: {
|
|
10512
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
10513
|
+
type: 'string',
|
|
10471
10514
|
},
|
|
10515
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
10472
10516
|
},
|
|
10473
|
-
required: ['
|
|
10517
|
+
required: ['type', 'message'],
|
|
10518
|
+
type: 'object',
|
|
10519
|
+
},
|
|
10520
|
+
result: {
|
|
10521
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
10522
|
+
nullable: true,
|
|
10523
|
+
},
|
|
10524
|
+
status: { enum: ['error'], type: 'string' },
|
|
10525
|
+
},
|
|
10526
|
+
required: [
|
|
10527
|
+
'action_attempt_id',
|
|
10528
|
+
'status',
|
|
10529
|
+
'result',
|
|
10530
|
+
'action_type',
|
|
10531
|
+
'error',
|
|
10532
|
+
],
|
|
10533
|
+
type: 'object',
|
|
10534
|
+
},
|
|
10535
|
+
{
|
|
10536
|
+
description: 'Pausing playback on the speaker is pending.',
|
|
10537
|
+
properties: {
|
|
10538
|
+
action_attempt_id: {
|
|
10539
|
+
description: 'ID of the action attempt.',
|
|
10540
|
+
format: 'uuid',
|
|
10541
|
+
type: 'string',
|
|
10542
|
+
},
|
|
10543
|
+
action_type: {
|
|
10544
|
+
description: 'Action attempt to track the status of pausing playback on a speaker.',
|
|
10545
|
+
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
10546
|
+
type: 'string',
|
|
10547
|
+
},
|
|
10548
|
+
error: {
|
|
10549
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
10550
|
+
nullable: true,
|
|
10551
|
+
},
|
|
10552
|
+
result: {
|
|
10553
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
10554
|
+
nullable: true,
|
|
10555
|
+
},
|
|
10556
|
+
status: { enum: ['pending'], type: 'string' },
|
|
10557
|
+
},
|
|
10558
|
+
required: [
|
|
10559
|
+
'action_attempt_id',
|
|
10560
|
+
'status',
|
|
10561
|
+
'result',
|
|
10562
|
+
'error',
|
|
10563
|
+
'action_type',
|
|
10564
|
+
],
|
|
10565
|
+
type: 'object',
|
|
10566
|
+
},
|
|
10567
|
+
{
|
|
10568
|
+
description: 'Pausing playback on the speaker succeeded.',
|
|
10569
|
+
properties: {
|
|
10570
|
+
action_attempt_id: {
|
|
10571
|
+
description: 'ID of the action attempt.',
|
|
10572
|
+
format: 'uuid',
|
|
10573
|
+
type: 'string',
|
|
10574
|
+
},
|
|
10575
|
+
action_type: {
|
|
10576
|
+
description: 'Action attempt to track the status of pausing playback on a speaker.',
|
|
10577
|
+
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
10578
|
+
type: 'string',
|
|
10579
|
+
},
|
|
10580
|
+
error: {
|
|
10581
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
10582
|
+
nullable: true,
|
|
10583
|
+
},
|
|
10584
|
+
result: {
|
|
10585
|
+
description: 'Result of the action.',
|
|
10586
|
+
properties: {
|
|
10587
|
+
affected_device_ids: {
|
|
10588
|
+
description: 'IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.',
|
|
10589
|
+
items: { format: 'uuid', type: 'string' },
|
|
10590
|
+
type: 'array',
|
|
10591
|
+
},
|
|
10592
|
+
},
|
|
10593
|
+
required: ['affected_device_ids'],
|
|
10474
10594
|
type: 'object',
|
|
10475
10595
|
},
|
|
10476
10596
|
status: { enum: ['success'], type: 'string' },
|
|
@@ -10485,6 +10605,7 @@ const openapi = {
|
|
|
10485
10605
|
type: 'object',
|
|
10486
10606
|
},
|
|
10487
10607
|
{
|
|
10608
|
+
description: 'Pausing playback on the speaker failed.',
|
|
10488
10609
|
properties: {
|
|
10489
10610
|
action_attempt_id: {
|
|
10490
10611
|
description: 'ID of the action attempt.',
|
|
@@ -10492,8 +10613,8 @@ const openapi = {
|
|
|
10492
10613
|
type: 'string',
|
|
10493
10614
|
},
|
|
10494
10615
|
action_type: {
|
|
10495
|
-
description: '
|
|
10496
|
-
enum: ['
|
|
10616
|
+
description: 'Action attempt to track the status of pausing playback on a speaker.',
|
|
10617
|
+
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
10497
10618
|
type: 'string',
|
|
10498
10619
|
},
|
|
10499
10620
|
error: {
|
|
@@ -10524,6 +10645,7 @@ const openapi = {
|
|
|
10524
10645
|
type: 'object',
|
|
10525
10646
|
},
|
|
10526
10647
|
{
|
|
10648
|
+
description: 'Resuming playback on the speaker is pending.',
|
|
10527
10649
|
properties: {
|
|
10528
10650
|
action_attempt_id: {
|
|
10529
10651
|
description: 'ID of the action attempt.',
|
|
@@ -10531,8 +10653,8 @@ const openapi = {
|
|
|
10531
10653
|
type: 'string',
|
|
10532
10654
|
},
|
|
10533
10655
|
action_type: {
|
|
10534
|
-
description: '
|
|
10535
|
-
enum: ['
|
|
10656
|
+
description: 'Action attempt to track the status of resuming playback on a speaker.',
|
|
10657
|
+
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
10536
10658
|
type: 'string',
|
|
10537
10659
|
},
|
|
10538
10660
|
error: {
|
|
@@ -10555,6 +10677,7 @@ const openapi = {
|
|
|
10555
10677
|
type: 'object',
|
|
10556
10678
|
},
|
|
10557
10679
|
{
|
|
10680
|
+
description: 'Resuming playback on the speaker succeeded.',
|
|
10558
10681
|
properties: {
|
|
10559
10682
|
action_attempt_id: {
|
|
10560
10683
|
description: 'ID of the action attempt.',
|
|
@@ -10562,8 +10685,120 @@ const openapi = {
|
|
|
10562
10685
|
type: 'string',
|
|
10563
10686
|
},
|
|
10564
10687
|
action_type: {
|
|
10565
|
-
description: '
|
|
10566
|
-
enum: ['
|
|
10688
|
+
description: 'Action attempt to track the status of resuming playback on a speaker.',
|
|
10689
|
+
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
10690
|
+
type: 'string',
|
|
10691
|
+
},
|
|
10692
|
+
error: {
|
|
10693
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
10694
|
+
nullable: true,
|
|
10695
|
+
},
|
|
10696
|
+
result: {
|
|
10697
|
+
description: 'Result of the action.',
|
|
10698
|
+
properties: {
|
|
10699
|
+
affected_device_ids: {
|
|
10700
|
+
description: 'IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.',
|
|
10701
|
+
items: { format: 'uuid', type: 'string' },
|
|
10702
|
+
type: 'array',
|
|
10703
|
+
},
|
|
10704
|
+
},
|
|
10705
|
+
required: ['affected_device_ids'],
|
|
10706
|
+
type: 'object',
|
|
10707
|
+
},
|
|
10708
|
+
status: { enum: ['success'], type: 'string' },
|
|
10709
|
+
},
|
|
10710
|
+
required: [
|
|
10711
|
+
'action_attempt_id',
|
|
10712
|
+
'status',
|
|
10713
|
+
'error',
|
|
10714
|
+
'action_type',
|
|
10715
|
+
'result',
|
|
10716
|
+
],
|
|
10717
|
+
type: 'object',
|
|
10718
|
+
},
|
|
10719
|
+
{
|
|
10720
|
+
description: 'Resuming playback on the speaker failed.',
|
|
10721
|
+
properties: {
|
|
10722
|
+
action_attempt_id: {
|
|
10723
|
+
description: 'ID of the action attempt.',
|
|
10724
|
+
format: 'uuid',
|
|
10725
|
+
type: 'string',
|
|
10726
|
+
},
|
|
10727
|
+
action_type: {
|
|
10728
|
+
description: 'Action attempt to track the status of resuming playback on a speaker.',
|
|
10729
|
+
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
10730
|
+
type: 'string',
|
|
10731
|
+
},
|
|
10732
|
+
error: {
|
|
10733
|
+
description: 'Error associated with the action.',
|
|
10734
|
+
properties: {
|
|
10735
|
+
message: {
|
|
10736
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
10737
|
+
type: 'string',
|
|
10738
|
+
},
|
|
10739
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
10740
|
+
},
|
|
10741
|
+
required: ['type', 'message'],
|
|
10742
|
+
type: 'object',
|
|
10743
|
+
},
|
|
10744
|
+
result: {
|
|
10745
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
10746
|
+
nullable: true,
|
|
10747
|
+
},
|
|
10748
|
+
status: { enum: ['error'], type: 'string' },
|
|
10749
|
+
},
|
|
10750
|
+
required: [
|
|
10751
|
+
'action_attempt_id',
|
|
10752
|
+
'status',
|
|
10753
|
+
'result',
|
|
10754
|
+
'action_type',
|
|
10755
|
+
'error',
|
|
10756
|
+
],
|
|
10757
|
+
type: 'object',
|
|
10758
|
+
},
|
|
10759
|
+
{
|
|
10760
|
+
description: 'Playing a chime on the speaker is pending.',
|
|
10761
|
+
properties: {
|
|
10762
|
+
action_attempt_id: {
|
|
10763
|
+
description: 'ID of the action attempt.',
|
|
10764
|
+
format: 'uuid',
|
|
10765
|
+
type: 'string',
|
|
10766
|
+
},
|
|
10767
|
+
action_type: {
|
|
10768
|
+
description: 'Action attempt to track the status of playing a chime on a speaker.',
|
|
10769
|
+
enum: ['PLAY_SPEAKER_CHIME'],
|
|
10770
|
+
type: 'string',
|
|
10771
|
+
},
|
|
10772
|
+
error: {
|
|
10773
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
10774
|
+
nullable: true,
|
|
10775
|
+
},
|
|
10776
|
+
result: {
|
|
10777
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
10778
|
+
nullable: true,
|
|
10779
|
+
},
|
|
10780
|
+
status: { enum: ['pending'], type: 'string' },
|
|
10781
|
+
},
|
|
10782
|
+
required: [
|
|
10783
|
+
'action_attempt_id',
|
|
10784
|
+
'status',
|
|
10785
|
+
'result',
|
|
10786
|
+
'error',
|
|
10787
|
+
'action_type',
|
|
10788
|
+
],
|
|
10789
|
+
type: 'object',
|
|
10790
|
+
},
|
|
10791
|
+
{
|
|
10792
|
+
description: 'Playing a chime on the speaker succeeded.',
|
|
10793
|
+
properties: {
|
|
10794
|
+
action_attempt_id: {
|
|
10795
|
+
description: 'ID of the action attempt.',
|
|
10796
|
+
format: 'uuid',
|
|
10797
|
+
type: 'string',
|
|
10798
|
+
},
|
|
10799
|
+
action_type: {
|
|
10800
|
+
description: 'Action attempt to track the status of playing a chime on a speaker.',
|
|
10801
|
+
enum: ['PLAY_SPEAKER_CHIME'],
|
|
10567
10802
|
type: 'string',
|
|
10568
10803
|
},
|
|
10569
10804
|
error: {
|
|
@@ -10587,6 +10822,7 @@ const openapi = {
|
|
|
10587
10822
|
type: 'object',
|
|
10588
10823
|
},
|
|
10589
10824
|
{
|
|
10825
|
+
description: 'Playing a chime on the speaker failed.',
|
|
10590
10826
|
properties: {
|
|
10591
10827
|
action_attempt_id: {
|
|
10592
10828
|
description: 'ID of the action attempt.',
|
|
@@ -10594,8 +10830,321 @@ const openapi = {
|
|
|
10594
10830
|
type: 'string',
|
|
10595
10831
|
},
|
|
10596
10832
|
action_type: {
|
|
10597
|
-
description: '
|
|
10598
|
-
enum: ['
|
|
10833
|
+
description: 'Action attempt to track the status of playing a chime on a speaker.',
|
|
10834
|
+
enum: ['PLAY_SPEAKER_CHIME'],
|
|
10835
|
+
type: 'string',
|
|
10836
|
+
},
|
|
10837
|
+
error: {
|
|
10838
|
+
description: 'Error associated with the action.',
|
|
10839
|
+
properties: {
|
|
10840
|
+
message: {
|
|
10841
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
10842
|
+
type: 'string',
|
|
10843
|
+
},
|
|
10844
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
10845
|
+
},
|
|
10846
|
+
required: ['type', 'message'],
|
|
10847
|
+
type: 'object',
|
|
10848
|
+
},
|
|
10849
|
+
result: {
|
|
10850
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
10851
|
+
nullable: true,
|
|
10852
|
+
},
|
|
10853
|
+
status: { enum: ['error'], type: 'string' },
|
|
10854
|
+
},
|
|
10855
|
+
required: [
|
|
10856
|
+
'action_attempt_id',
|
|
10857
|
+
'status',
|
|
10858
|
+
'result',
|
|
10859
|
+
'action_type',
|
|
10860
|
+
'error',
|
|
10861
|
+
],
|
|
10862
|
+
type: 'object',
|
|
10863
|
+
},
|
|
10864
|
+
{
|
|
10865
|
+
properties: {
|
|
10866
|
+
action_attempt_id: {
|
|
10867
|
+
description: 'ID of the action attempt.',
|
|
10868
|
+
format: 'uuid',
|
|
10869
|
+
type: 'string',
|
|
10870
|
+
},
|
|
10871
|
+
action_type: {
|
|
10872
|
+
description: 'Syncing access codes is pending.',
|
|
10873
|
+
enum: ['SYNC_ACCESS_CODES'],
|
|
10874
|
+
type: 'string',
|
|
10875
|
+
},
|
|
10876
|
+
error: {
|
|
10877
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
10878
|
+
nullable: true,
|
|
10879
|
+
},
|
|
10880
|
+
result: {
|
|
10881
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
10882
|
+
nullable: true,
|
|
10883
|
+
},
|
|
10884
|
+
status: { enum: ['pending'], type: 'string' },
|
|
10885
|
+
},
|
|
10886
|
+
required: [
|
|
10887
|
+
'action_attempt_id',
|
|
10888
|
+
'status',
|
|
10889
|
+
'result',
|
|
10890
|
+
'error',
|
|
10891
|
+
'action_type',
|
|
10892
|
+
],
|
|
10893
|
+
type: 'object',
|
|
10894
|
+
},
|
|
10895
|
+
{
|
|
10896
|
+
properties: {
|
|
10897
|
+
action_attempt_id: {
|
|
10898
|
+
description: 'ID of the action attempt.',
|
|
10899
|
+
format: 'uuid',
|
|
10900
|
+
type: 'string',
|
|
10901
|
+
},
|
|
10902
|
+
action_type: {
|
|
10903
|
+
description: 'Syncing access codes succeeded.',
|
|
10904
|
+
enum: ['SYNC_ACCESS_CODES'],
|
|
10905
|
+
type: 'string',
|
|
10906
|
+
},
|
|
10907
|
+
error: {
|
|
10908
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
10909
|
+
nullable: true,
|
|
10910
|
+
},
|
|
10911
|
+
result: {
|
|
10912
|
+
description: 'Result of the action.',
|
|
10913
|
+
properties: {},
|
|
10914
|
+
type: 'object',
|
|
10915
|
+
},
|
|
10916
|
+
status: { enum: ['success'], type: 'string' },
|
|
10917
|
+
},
|
|
10918
|
+
required: [
|
|
10919
|
+
'action_attempt_id',
|
|
10920
|
+
'status',
|
|
10921
|
+
'error',
|
|
10922
|
+
'action_type',
|
|
10923
|
+
'result',
|
|
10924
|
+
],
|
|
10925
|
+
type: 'object',
|
|
10926
|
+
},
|
|
10927
|
+
{
|
|
10928
|
+
properties: {
|
|
10929
|
+
action_attempt_id: {
|
|
10930
|
+
description: 'ID of the action attempt.',
|
|
10931
|
+
format: 'uuid',
|
|
10932
|
+
type: 'string',
|
|
10933
|
+
},
|
|
10934
|
+
action_type: {
|
|
10935
|
+
description: 'Syncing access codes failed.',
|
|
10936
|
+
enum: ['SYNC_ACCESS_CODES'],
|
|
10937
|
+
type: 'string',
|
|
10938
|
+
},
|
|
10939
|
+
error: {
|
|
10940
|
+
description: 'Error associated with the action.',
|
|
10941
|
+
properties: {
|
|
10942
|
+
message: {
|
|
10943
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
10944
|
+
type: 'string',
|
|
10945
|
+
},
|
|
10946
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
10947
|
+
},
|
|
10948
|
+
required: ['type', 'message'],
|
|
10949
|
+
type: 'object',
|
|
10950
|
+
},
|
|
10951
|
+
result: {
|
|
10952
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
10953
|
+
nullable: true,
|
|
10954
|
+
},
|
|
10955
|
+
status: { enum: ['error'], type: 'string' },
|
|
10956
|
+
},
|
|
10957
|
+
required: [
|
|
10958
|
+
'action_attempt_id',
|
|
10959
|
+
'status',
|
|
10960
|
+
'result',
|
|
10961
|
+
'action_type',
|
|
10962
|
+
'error',
|
|
10963
|
+
],
|
|
10964
|
+
type: 'object',
|
|
10965
|
+
},
|
|
10966
|
+
{
|
|
10967
|
+
properties: {
|
|
10968
|
+
action_attempt_id: {
|
|
10969
|
+
description: 'ID of the action attempt.',
|
|
10970
|
+
format: 'uuid',
|
|
10971
|
+
type: 'string',
|
|
10972
|
+
},
|
|
10973
|
+
action_type: {
|
|
10974
|
+
description: 'Creating an access code is pending.',
|
|
10975
|
+
enum: ['CREATE_ACCESS_CODE'],
|
|
10976
|
+
type: 'string',
|
|
10977
|
+
},
|
|
10978
|
+
error: {
|
|
10979
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
10980
|
+
nullable: true,
|
|
10981
|
+
},
|
|
10982
|
+
result: {
|
|
10983
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
10984
|
+
nullable: true,
|
|
10985
|
+
},
|
|
10986
|
+
status: { enum: ['pending'], type: 'string' },
|
|
10987
|
+
},
|
|
10988
|
+
required: [
|
|
10989
|
+
'action_attempt_id',
|
|
10990
|
+
'status',
|
|
10991
|
+
'result',
|
|
10992
|
+
'error',
|
|
10993
|
+
'action_type',
|
|
10994
|
+
],
|
|
10995
|
+
type: 'object',
|
|
10996
|
+
},
|
|
10997
|
+
{
|
|
10998
|
+
properties: {
|
|
10999
|
+
action_attempt_id: {
|
|
11000
|
+
description: 'ID of the action attempt.',
|
|
11001
|
+
format: 'uuid',
|
|
11002
|
+
type: 'string',
|
|
11003
|
+
},
|
|
11004
|
+
action_type: {
|
|
11005
|
+
description: 'Creating an access code succeeded.',
|
|
11006
|
+
enum: ['CREATE_ACCESS_CODE'],
|
|
11007
|
+
type: 'string',
|
|
11008
|
+
},
|
|
11009
|
+
error: {
|
|
11010
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
11011
|
+
nullable: true,
|
|
11012
|
+
},
|
|
11013
|
+
result: {
|
|
11014
|
+
description: 'Result of the action.',
|
|
11015
|
+
properties: {
|
|
11016
|
+
access_code: {
|
|
11017
|
+
additionalProperties: {},
|
|
11018
|
+
description: 'Created access code.',
|
|
11019
|
+
type: 'object',
|
|
11020
|
+
},
|
|
11021
|
+
},
|
|
11022
|
+
required: ['access_code'],
|
|
11023
|
+
type: 'object',
|
|
11024
|
+
},
|
|
11025
|
+
status: { enum: ['success'], type: 'string' },
|
|
11026
|
+
},
|
|
11027
|
+
required: [
|
|
11028
|
+
'action_attempt_id',
|
|
11029
|
+
'status',
|
|
11030
|
+
'error',
|
|
11031
|
+
'action_type',
|
|
11032
|
+
'result',
|
|
11033
|
+
],
|
|
11034
|
+
type: 'object',
|
|
11035
|
+
},
|
|
11036
|
+
{
|
|
11037
|
+
properties: {
|
|
11038
|
+
action_attempt_id: {
|
|
11039
|
+
description: 'ID of the action attempt.',
|
|
11040
|
+
format: 'uuid',
|
|
11041
|
+
type: 'string',
|
|
11042
|
+
},
|
|
11043
|
+
action_type: {
|
|
11044
|
+
description: 'Creating an access code failed.',
|
|
11045
|
+
enum: ['CREATE_ACCESS_CODE'],
|
|
11046
|
+
type: 'string',
|
|
11047
|
+
},
|
|
11048
|
+
error: {
|
|
11049
|
+
description: 'Error associated with the action.',
|
|
11050
|
+
properties: {
|
|
11051
|
+
message: {
|
|
11052
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
11053
|
+
type: 'string',
|
|
11054
|
+
},
|
|
11055
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
11056
|
+
},
|
|
11057
|
+
required: ['type', 'message'],
|
|
11058
|
+
type: 'object',
|
|
11059
|
+
},
|
|
11060
|
+
result: {
|
|
11061
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
11062
|
+
nullable: true,
|
|
11063
|
+
},
|
|
11064
|
+
status: { enum: ['error'], type: 'string' },
|
|
11065
|
+
},
|
|
11066
|
+
required: [
|
|
11067
|
+
'action_attempt_id',
|
|
11068
|
+
'status',
|
|
11069
|
+
'result',
|
|
11070
|
+
'action_type',
|
|
11071
|
+
'error',
|
|
11072
|
+
],
|
|
11073
|
+
type: 'object',
|
|
11074
|
+
},
|
|
11075
|
+
{
|
|
11076
|
+
properties: {
|
|
11077
|
+
action_attempt_id: {
|
|
11078
|
+
description: 'ID of the action attempt.',
|
|
11079
|
+
format: 'uuid',
|
|
11080
|
+
type: 'string',
|
|
11081
|
+
},
|
|
11082
|
+
action_type: {
|
|
11083
|
+
description: 'Deleting an access code is pending.',
|
|
11084
|
+
enum: ['DELETE_ACCESS_CODE'],
|
|
11085
|
+
type: 'string',
|
|
11086
|
+
},
|
|
11087
|
+
error: {
|
|
11088
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
11089
|
+
nullable: true,
|
|
11090
|
+
},
|
|
11091
|
+
result: {
|
|
11092
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
11093
|
+
nullable: true,
|
|
11094
|
+
},
|
|
11095
|
+
status: { enum: ['pending'], type: 'string' },
|
|
11096
|
+
},
|
|
11097
|
+
required: [
|
|
11098
|
+
'action_attempt_id',
|
|
11099
|
+
'status',
|
|
11100
|
+
'result',
|
|
11101
|
+
'error',
|
|
11102
|
+
'action_type',
|
|
11103
|
+
],
|
|
11104
|
+
type: 'object',
|
|
11105
|
+
},
|
|
11106
|
+
{
|
|
11107
|
+
properties: {
|
|
11108
|
+
action_attempt_id: {
|
|
11109
|
+
description: 'ID of the action attempt.',
|
|
11110
|
+
format: 'uuid',
|
|
11111
|
+
type: 'string',
|
|
11112
|
+
},
|
|
11113
|
+
action_type: {
|
|
11114
|
+
description: 'Deleting an access code succeeded.',
|
|
11115
|
+
enum: ['DELETE_ACCESS_CODE'],
|
|
11116
|
+
type: 'string',
|
|
11117
|
+
},
|
|
11118
|
+
error: {
|
|
11119
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
11120
|
+
nullable: true,
|
|
11121
|
+
},
|
|
11122
|
+
result: {
|
|
11123
|
+
description: 'Result of the action.',
|
|
11124
|
+
properties: {},
|
|
11125
|
+
type: 'object',
|
|
11126
|
+
},
|
|
11127
|
+
status: { enum: ['success'], type: 'string' },
|
|
11128
|
+
},
|
|
11129
|
+
required: [
|
|
11130
|
+
'action_attempt_id',
|
|
11131
|
+
'status',
|
|
11132
|
+
'error',
|
|
11133
|
+
'action_type',
|
|
11134
|
+
'result',
|
|
11135
|
+
],
|
|
11136
|
+
type: 'object',
|
|
11137
|
+
},
|
|
11138
|
+
{
|
|
11139
|
+
properties: {
|
|
11140
|
+
action_attempt_id: {
|
|
11141
|
+
description: 'ID of the action attempt.',
|
|
11142
|
+
format: 'uuid',
|
|
11143
|
+
type: 'string',
|
|
11144
|
+
},
|
|
11145
|
+
action_type: {
|
|
11146
|
+
description: 'Deleting an access code failed.',
|
|
11147
|
+
enum: ['DELETE_ACCESS_CODE'],
|
|
10599
11148
|
type: 'string',
|
|
10600
11149
|
},
|
|
10601
11150
|
error: {
|
|
@@ -11543,6 +12092,7 @@ const openapi = {
|
|
|
11543
12092
|
'noise_sensor',
|
|
11544
12093
|
'access_control',
|
|
11545
12094
|
'camera',
|
|
12095
|
+
'speaker',
|
|
11546
12096
|
],
|
|
11547
12097
|
type: 'string',
|
|
11548
12098
|
},
|
|
@@ -11691,6 +12241,7 @@ const openapi = {
|
|
|
11691
12241
|
'noise_sensor',
|
|
11692
12242
|
'access_control',
|
|
11693
12243
|
'camera',
|
|
12244
|
+
'speaker',
|
|
11694
12245
|
],
|
|
11695
12246
|
type: 'string',
|
|
11696
12247
|
},
|
|
@@ -12326,6 +12877,18 @@ const openapi = {
|
|
|
12326
12877
|
description: 'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
12327
12878
|
type: 'boolean',
|
|
12328
12879
|
},
|
|
12880
|
+
can_mute_speaker: {
|
|
12881
|
+
description: 'Indicates whether the speaker supports muting and unmuting.',
|
|
12882
|
+
type: 'boolean',
|
|
12883
|
+
},
|
|
12884
|
+
can_pause_speaker_playback: {
|
|
12885
|
+
description: 'Indicates whether the speaker supports pausing and resuming playback.',
|
|
12886
|
+
type: 'boolean',
|
|
12887
|
+
},
|
|
12888
|
+
can_play_speaker_chime: {
|
|
12889
|
+
description: 'Indicates whether the speaker supports playing a chime.',
|
|
12890
|
+
type: 'boolean',
|
|
12891
|
+
},
|
|
12329
12892
|
can_program_offline_access_codes: {
|
|
12330
12893
|
description: 'Indicates whether the device supports programming offline access codes.',
|
|
12331
12894
|
type: 'boolean',
|
|
@@ -12358,6 +12921,10 @@ const openapi = {
|
|
|
12358
12921
|
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
12359
12922
|
type: 'boolean',
|
|
12360
12923
|
},
|
|
12924
|
+
can_set_speaker_volume: {
|
|
12925
|
+
description: 'Indicates whether the speaker supports setting its volume.',
|
|
12926
|
+
type: 'boolean',
|
|
12927
|
+
},
|
|
12361
12928
|
can_simulate_connection: {
|
|
12362
12929
|
description: 'Indicates whether the device supports simulating connection in a sandbox.',
|
|
12363
12930
|
type: 'boolean',
|
|
@@ -12559,6 +13126,11 @@ const openapi = {
|
|
|
12559
13126
|
],
|
|
12560
13127
|
type: 'string',
|
|
12561
13128
|
},
|
|
13129
|
+
{
|
|
13130
|
+
description: 'Device type for speakers.',
|
|
13131
|
+
enum: ['sonos_speaker'],
|
|
13132
|
+
type: 'string',
|
|
13133
|
+
},
|
|
12562
13134
|
],
|
|
12563
13135
|
},
|
|
12564
13136
|
display_name: {
|
|
@@ -14386,6 +14958,33 @@ const openapi = {
|
|
|
14386
14958
|
},
|
|
14387
14959
|
type: 'object',
|
|
14388
14960
|
},
|
|
14961
|
+
sonos_metadata: {
|
|
14962
|
+
description: 'Metadata for a Sonos speaker.',
|
|
14963
|
+
properties: {
|
|
14964
|
+
bonded_member_models: {
|
|
14965
|
+
description: 'Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.',
|
|
14966
|
+
items: { type: 'string' },
|
|
14967
|
+
type: 'array',
|
|
14968
|
+
},
|
|
14969
|
+
household_id: {
|
|
14970
|
+
description: 'ID of the Sonos household that the speaker belongs to.',
|
|
14971
|
+
type: 'string',
|
|
14972
|
+
},
|
|
14973
|
+
model_display_name: {
|
|
14974
|
+
description: 'Model name of the speaker, as reported by Sonos.',
|
|
14975
|
+
type: 'string',
|
|
14976
|
+
},
|
|
14977
|
+
player_id: {
|
|
14978
|
+
description: 'ID of the Sonos player for the speaker.',
|
|
14979
|
+
type: 'string',
|
|
14980
|
+
},
|
|
14981
|
+
software_version: {
|
|
14982
|
+
description: 'Software version running on the speaker.',
|
|
14983
|
+
type: 'string',
|
|
14984
|
+
},
|
|
14985
|
+
},
|
|
14986
|
+
type: 'object',
|
|
14987
|
+
},
|
|
14389
14988
|
tado_metadata: {
|
|
14390
14989
|
description: 'Metadata for a tado° device.',
|
|
14391
14990
|
properties: {
|
|
@@ -14897,6 +15496,95 @@ const openapi = {
|
|
|
14897
15496
|
type: 'array',
|
|
14898
15497
|
'x-property-group-key': 'access_codes',
|
|
14899
15498
|
},
|
|
15499
|
+
speaker: {
|
|
15500
|
+
description: 'Audio state and capabilities of the speaker.',
|
|
15501
|
+
properties: {
|
|
15502
|
+
grouped_with_device_ids: {
|
|
15503
|
+
description: 'IDs of the other speakers that are currently grouped with this speaker. Pausing or resuming playback on a speaker also affects the speakers in its group.',
|
|
15504
|
+
items: { format: 'uuid', type: 'string' },
|
|
15505
|
+
type: 'array',
|
|
15506
|
+
},
|
|
15507
|
+
has_fixed_volume: {
|
|
15508
|
+
description: "Indicates whether the speaker's volume is fixed, for example, because the speaker's line-out level is controlled by an external amplifier. A speaker with a fixed volume cannot have its volume set through Seam.",
|
|
15509
|
+
type: 'boolean',
|
|
15510
|
+
},
|
|
15511
|
+
is_muted: {
|
|
15512
|
+
description: 'Indicates whether the speaker is muted.',
|
|
15513
|
+
type: 'boolean',
|
|
15514
|
+
},
|
|
15515
|
+
max_volume: {
|
|
15516
|
+
description: "Maximum volume that you can set on the speaker. This is the ceiling of the speaker's native volume scale, not a limit configured for guests.",
|
|
15517
|
+
format: 'float',
|
|
15518
|
+
type: 'number',
|
|
15519
|
+
},
|
|
15520
|
+
min_volume: {
|
|
15521
|
+
description: 'Minimum volume that you can set on the speaker.',
|
|
15522
|
+
format: 'float',
|
|
15523
|
+
type: 'number',
|
|
15524
|
+
},
|
|
15525
|
+
now_playing: {
|
|
15526
|
+
description: 'Content that is currently playing on the speaker.',
|
|
15527
|
+
properties: {
|
|
15528
|
+
album: {
|
|
15529
|
+
description: 'Album of the content that is currently playing.',
|
|
15530
|
+
type: 'string',
|
|
15531
|
+
},
|
|
15532
|
+
artist: {
|
|
15533
|
+
description: 'Artist of the content that is currently playing.',
|
|
15534
|
+
type: 'string',
|
|
15535
|
+
},
|
|
15536
|
+
title: {
|
|
15537
|
+
description: 'Title of the content that is currently playing.',
|
|
15538
|
+
type: 'string',
|
|
15539
|
+
},
|
|
15540
|
+
},
|
|
15541
|
+
type: 'object',
|
|
15542
|
+
},
|
|
15543
|
+
playback_state: {
|
|
15544
|
+
description: 'Playback state of the speaker.',
|
|
15545
|
+
enum: [
|
|
15546
|
+
'playing',
|
|
15547
|
+
'paused',
|
|
15548
|
+
'idle',
|
|
15549
|
+
'buffering',
|
|
15550
|
+
'unknown',
|
|
15551
|
+
],
|
|
15552
|
+
type: 'string',
|
|
15553
|
+
},
|
|
15554
|
+
supports_chime: {
|
|
15555
|
+
description: 'Indicates whether the speaker can play a chime.',
|
|
15556
|
+
type: 'boolean',
|
|
15557
|
+
},
|
|
15558
|
+
volume: {
|
|
15559
|
+
description: "Current volume of the speaker, on the speaker's native volume scale from `min_volume` to `max_volume`. This is the native volume setting, not a decibel level.",
|
|
15560
|
+
format: 'float',
|
|
15561
|
+
type: 'number',
|
|
15562
|
+
},
|
|
15563
|
+
volume_reported_at: {
|
|
15564
|
+
description: 'Date and time at which the speaker last reported its volume.',
|
|
15565
|
+
format: 'date-time',
|
|
15566
|
+
type: 'string',
|
|
15567
|
+
},
|
|
15568
|
+
volume_step: {
|
|
15569
|
+
description: 'Increment between the volume values that you can set on the speaker.',
|
|
15570
|
+
format: 'float',
|
|
15571
|
+
type: 'number',
|
|
15572
|
+
},
|
|
15573
|
+
},
|
|
15574
|
+
required: [
|
|
15575
|
+
'volume',
|
|
15576
|
+
'is_muted',
|
|
15577
|
+
'has_fixed_volume',
|
|
15578
|
+
'min_volume',
|
|
15579
|
+
'max_volume',
|
|
15580
|
+
'volume_step',
|
|
15581
|
+
'playback_state',
|
|
15582
|
+
'grouped_with_device_ids',
|
|
15583
|
+
'supports_chime',
|
|
15584
|
+
],
|
|
15585
|
+
type: 'object',
|
|
15586
|
+
'x-property-group-key': 'speakers',
|
|
15587
|
+
},
|
|
14900
15588
|
supported_code_lengths: {
|
|
14901
15589
|
description: 'Supported code lengths for access codes.',
|
|
14902
15590
|
items: { format: 'float', type: 'number' },
|
|
@@ -15681,6 +16369,7 @@ const openapi = {
|
|
|
15681
16369
|
noise_sensors: { name: 'Noise Sensors' },
|
|
15682
16370
|
phones: { name: 'Phones' },
|
|
15683
16371
|
provider_metadata: { name: 'Provider Metadata' },
|
|
16372
|
+
speakers: { name: 'Speakers' },
|
|
15684
16373
|
thermostats: { name: 'Thermostats' },
|
|
15685
16374
|
},
|
|
15686
16375
|
},
|
|
@@ -16364,6 +17053,7 @@ const openapi = {
|
|
|
16364
17053
|
noise_sensors: { name: 'Noise Sensors' },
|
|
16365
17054
|
phones: { name: 'Phones' },
|
|
16366
17055
|
provider_metadata: { name: 'Provider Metadata' },
|
|
17056
|
+
speakers: { name: 'Speakers' },
|
|
16367
17057
|
thermostats: { name: 'Thermostats' },
|
|
16368
17058
|
},
|
|
16369
17059
|
'x-route-path': '/devices',
|
|
@@ -16390,6 +17080,18 @@ const openapi = {
|
|
|
16390
17080
|
description: 'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
16391
17081
|
type: 'boolean',
|
|
16392
17082
|
},
|
|
17083
|
+
can_mute_speaker: {
|
|
17084
|
+
description: 'Indicates whether the speaker supports muting and unmuting.',
|
|
17085
|
+
type: 'boolean',
|
|
17086
|
+
},
|
|
17087
|
+
can_pause_speaker_playback: {
|
|
17088
|
+
description: 'Indicates whether the speaker supports pausing and resuming playback.',
|
|
17089
|
+
type: 'boolean',
|
|
17090
|
+
},
|
|
17091
|
+
can_play_speaker_chime: {
|
|
17092
|
+
description: 'Indicates whether the speaker supports playing a chime.',
|
|
17093
|
+
type: 'boolean',
|
|
17094
|
+
},
|
|
16393
17095
|
can_program_offline_access_codes: {
|
|
16394
17096
|
description: 'Indicates whether the device supports programming offline access codes.',
|
|
16395
17097
|
type: 'boolean',
|
|
@@ -16422,6 +17124,10 @@ const openapi = {
|
|
|
16422
17124
|
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
16423
17125
|
type: 'boolean',
|
|
16424
17126
|
},
|
|
17127
|
+
can_set_speaker_volume: {
|
|
17128
|
+
description: 'Indicates whether the speaker supports setting its volume.',
|
|
17129
|
+
type: 'boolean',
|
|
17130
|
+
},
|
|
16425
17131
|
can_simulate_connection: {
|
|
16426
17132
|
description: 'Indicates whether the device supports simulating connection in a sandbox.',
|
|
16427
17133
|
type: 'boolean',
|
|
@@ -27087,97 +27793,1192 @@ const openapi = {
|
|
|
27087
27793
|
type: 'string',
|
|
27088
27794
|
},
|
|
27089
27795
|
errors: {
|
|
27090
|
-
description: '
|
|
27796
|
+
description: 'Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
27091
27797
|
items: {
|
|
27092
|
-
|
|
27093
|
-
|
|
27094
|
-
|
|
27095
|
-
|
|
27096
|
-
|
|
27798
|
+
discriminator: { propertyName: 'error_code' },
|
|
27799
|
+
oneOf: [
|
|
27800
|
+
{
|
|
27801
|
+
description: 'Indicates that the account is disconnected.',
|
|
27802
|
+
properties: {
|
|
27803
|
+
created_at: {
|
|
27804
|
+
description: 'Date and time at which Seam created the error.',
|
|
27805
|
+
format: 'date-time',
|
|
27806
|
+
type: 'string',
|
|
27807
|
+
},
|
|
27808
|
+
error_code: {
|
|
27809
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27810
|
+
enum: ['account_disconnected'],
|
|
27811
|
+
type: 'string',
|
|
27812
|
+
},
|
|
27813
|
+
is_connected_account_error: {
|
|
27814
|
+
description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
27815
|
+
enum: [true],
|
|
27816
|
+
type: 'boolean',
|
|
27817
|
+
},
|
|
27818
|
+
is_device_error: {
|
|
27819
|
+
description: 'Indicates that the error is not a device error.',
|
|
27820
|
+
enum: [false],
|
|
27821
|
+
type: 'boolean',
|
|
27822
|
+
},
|
|
27823
|
+
message: {
|
|
27824
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27825
|
+
type: 'string',
|
|
27826
|
+
},
|
|
27827
|
+
},
|
|
27828
|
+
required: [
|
|
27829
|
+
'message',
|
|
27830
|
+
'is_device_error',
|
|
27831
|
+
'created_at',
|
|
27832
|
+
'error_code',
|
|
27833
|
+
'is_connected_account_error',
|
|
27834
|
+
],
|
|
27835
|
+
type: 'object',
|
|
27836
|
+
'x-resource-type': 'connected_account',
|
|
27837
|
+
},
|
|
27838
|
+
{
|
|
27839
|
+
description: 'Indicates that the Salto site user limit has been reached.',
|
|
27840
|
+
properties: {
|
|
27841
|
+
created_at: {
|
|
27842
|
+
description: 'Date and time at which Seam created the error.',
|
|
27843
|
+
format: 'date-time',
|
|
27844
|
+
type: 'string',
|
|
27845
|
+
},
|
|
27846
|
+
error_code: {
|
|
27847
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27848
|
+
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
27849
|
+
type: 'string',
|
|
27850
|
+
},
|
|
27851
|
+
is_connected_account_error: {
|
|
27852
|
+
description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
27853
|
+
enum: [true],
|
|
27854
|
+
type: 'boolean',
|
|
27855
|
+
},
|
|
27856
|
+
is_device_error: {
|
|
27857
|
+
description: 'Indicates that the error is not a device error.',
|
|
27858
|
+
enum: [false],
|
|
27859
|
+
type: 'boolean',
|
|
27860
|
+
},
|
|
27861
|
+
message: {
|
|
27862
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27863
|
+
type: 'string',
|
|
27864
|
+
},
|
|
27865
|
+
},
|
|
27866
|
+
required: [
|
|
27867
|
+
'message',
|
|
27868
|
+
'is_device_error',
|
|
27869
|
+
'created_at',
|
|
27870
|
+
'error_code',
|
|
27871
|
+
'is_connected_account_error',
|
|
27872
|
+
],
|
|
27873
|
+
type: 'object',
|
|
27874
|
+
'x-resource-type': 'connected_account',
|
|
27875
|
+
'x-variant-group-key': 'locks',
|
|
27876
|
+
},
|
|
27877
|
+
{
|
|
27878
|
+
description: "Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
|
|
27879
|
+
properties: {
|
|
27880
|
+
created_at: {
|
|
27881
|
+
description: 'Date and time at which Seam created the error.',
|
|
27882
|
+
format: 'date-time',
|
|
27883
|
+
type: 'string',
|
|
27884
|
+
},
|
|
27885
|
+
error_code: {
|
|
27886
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27887
|
+
enum: ['insufficient_permissions'],
|
|
27888
|
+
type: 'string',
|
|
27889
|
+
},
|
|
27890
|
+
is_connected_account_error: {
|
|
27891
|
+
description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
27892
|
+
enum: [true],
|
|
27893
|
+
type: 'boolean',
|
|
27894
|
+
},
|
|
27895
|
+
is_device_error: {
|
|
27896
|
+
description: 'Indicates that the error is not a device error.',
|
|
27897
|
+
enum: [false],
|
|
27898
|
+
type: 'boolean',
|
|
27899
|
+
},
|
|
27900
|
+
message: {
|
|
27901
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27902
|
+
type: 'string',
|
|
27903
|
+
},
|
|
27904
|
+
},
|
|
27905
|
+
required: [
|
|
27906
|
+
'message',
|
|
27907
|
+
'is_device_error',
|
|
27908
|
+
'created_at',
|
|
27909
|
+
'error_code',
|
|
27910
|
+
'is_connected_account_error',
|
|
27911
|
+
],
|
|
27912
|
+
type: 'object',
|
|
27913
|
+
'x-resource-type': 'connected_account',
|
|
27914
|
+
},
|
|
27915
|
+
{
|
|
27916
|
+
description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
|
|
27917
|
+
properties: {
|
|
27918
|
+
created_at: {
|
|
27919
|
+
description: 'Date and time at which Seam created the error.',
|
|
27920
|
+
format: 'date-time',
|
|
27921
|
+
type: 'string',
|
|
27922
|
+
},
|
|
27923
|
+
error_code: {
|
|
27924
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27925
|
+
enum: ['dormakaba_sites_disconnected'],
|
|
27926
|
+
type: 'string',
|
|
27927
|
+
},
|
|
27928
|
+
is_connected_account_error: {
|
|
27929
|
+
description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
27930
|
+
enum: [true],
|
|
27931
|
+
type: 'boolean',
|
|
27932
|
+
},
|
|
27933
|
+
is_device_error: {
|
|
27934
|
+
description: 'Indicates that the error is not a device error.',
|
|
27935
|
+
enum: [false],
|
|
27936
|
+
type: 'boolean',
|
|
27937
|
+
},
|
|
27938
|
+
message: {
|
|
27939
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27940
|
+
type: 'string',
|
|
27941
|
+
},
|
|
27942
|
+
},
|
|
27943
|
+
required: [
|
|
27944
|
+
'message',
|
|
27945
|
+
'is_device_error',
|
|
27946
|
+
'created_at',
|
|
27947
|
+
'error_code',
|
|
27948
|
+
'is_connected_account_error',
|
|
27949
|
+
],
|
|
27950
|
+
type: 'object',
|
|
27951
|
+
'x-resource-type': 'connected_account',
|
|
27952
|
+
'x-variant-group-key': 'locks',
|
|
27953
|
+
},
|
|
27954
|
+
{
|
|
27955
|
+
deprecated: true,
|
|
27956
|
+
description: 'Indicates that the device is offline.',
|
|
27957
|
+
properties: {
|
|
27958
|
+
created_at: {
|
|
27959
|
+
description: 'Date and time at which Seam created the error.',
|
|
27960
|
+
format: 'date-time',
|
|
27961
|
+
type: 'string',
|
|
27962
|
+
},
|
|
27963
|
+
error_code: {
|
|
27964
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27965
|
+
enum: ['device_offline'],
|
|
27966
|
+
type: 'string',
|
|
27967
|
+
},
|
|
27968
|
+
is_device_error: {
|
|
27969
|
+
description: 'Indicates that the error is a device error.',
|
|
27970
|
+
enum: [true],
|
|
27971
|
+
type: 'boolean',
|
|
27972
|
+
},
|
|
27973
|
+
message: {
|
|
27974
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
27975
|
+
type: 'string',
|
|
27976
|
+
},
|
|
27977
|
+
},
|
|
27978
|
+
required: [
|
|
27979
|
+
'message',
|
|
27980
|
+
'is_device_error',
|
|
27981
|
+
'created_at',
|
|
27982
|
+
'error_code',
|
|
27983
|
+
],
|
|
27984
|
+
type: 'object',
|
|
27985
|
+
'x-deprecated': 'Use `device_disconnected` instead.',
|
|
27986
|
+
'x-resource-type': 'device',
|
|
27987
|
+
},
|
|
27988
|
+
{
|
|
27989
|
+
description: 'Indicates that the device has been removed.',
|
|
27990
|
+
properties: {
|
|
27991
|
+
created_at: {
|
|
27992
|
+
description: 'Date and time at which Seam created the error.',
|
|
27993
|
+
format: 'date-time',
|
|
27994
|
+
type: 'string',
|
|
27995
|
+
},
|
|
27996
|
+
error_code: {
|
|
27997
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
27998
|
+
enum: ['device_removed'],
|
|
27999
|
+
type: 'string',
|
|
28000
|
+
},
|
|
28001
|
+
is_device_error: {
|
|
28002
|
+
description: 'Indicates that the error is a device error.',
|
|
28003
|
+
enum: [true],
|
|
28004
|
+
type: 'boolean',
|
|
28005
|
+
},
|
|
28006
|
+
message: {
|
|
28007
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28008
|
+
type: 'string',
|
|
28009
|
+
},
|
|
28010
|
+
},
|
|
28011
|
+
required: [
|
|
28012
|
+
'message',
|
|
28013
|
+
'is_device_error',
|
|
28014
|
+
'created_at',
|
|
28015
|
+
'error_code',
|
|
28016
|
+
],
|
|
28017
|
+
type: 'object',
|
|
28018
|
+
'x-resource-type': 'device',
|
|
28019
|
+
},
|
|
28020
|
+
{
|
|
28021
|
+
description: 'Indicates that the hub is disconnected.',
|
|
28022
|
+
properties: {
|
|
28023
|
+
created_at: {
|
|
28024
|
+
description: 'Date and time at which Seam created the error.',
|
|
28025
|
+
format: 'date-time',
|
|
28026
|
+
type: 'string',
|
|
28027
|
+
},
|
|
28028
|
+
error_code: {
|
|
28029
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28030
|
+
enum: ['hub_disconnected'],
|
|
28031
|
+
type: 'string',
|
|
28032
|
+
},
|
|
28033
|
+
is_device_error: {
|
|
28034
|
+
description: 'Indicates that the error is a device error.',
|
|
28035
|
+
enum: [true],
|
|
28036
|
+
type: 'boolean',
|
|
28037
|
+
},
|
|
28038
|
+
message: {
|
|
28039
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28040
|
+
type: 'string',
|
|
28041
|
+
},
|
|
28042
|
+
},
|
|
28043
|
+
required: [
|
|
28044
|
+
'message',
|
|
28045
|
+
'is_device_error',
|
|
28046
|
+
'created_at',
|
|
28047
|
+
'error_code',
|
|
28048
|
+
],
|
|
28049
|
+
type: 'object',
|
|
28050
|
+
'x-resource-type': 'device',
|
|
28051
|
+
},
|
|
28052
|
+
{
|
|
28053
|
+
description: 'Indicates that the device is disconnected.',
|
|
28054
|
+
properties: {
|
|
28055
|
+
created_at: {
|
|
28056
|
+
description: 'Date and time at which Seam created the error.',
|
|
28057
|
+
format: 'date-time',
|
|
28058
|
+
type: 'string',
|
|
28059
|
+
},
|
|
28060
|
+
error_code: {
|
|
28061
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28062
|
+
enum: ['device_disconnected'],
|
|
28063
|
+
type: 'string',
|
|
28064
|
+
},
|
|
28065
|
+
is_device_error: {
|
|
28066
|
+
description: 'Indicates that the error is a device error.',
|
|
28067
|
+
enum: [true],
|
|
28068
|
+
type: 'boolean',
|
|
28069
|
+
},
|
|
28070
|
+
message: {
|
|
28071
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28072
|
+
type: 'string',
|
|
28073
|
+
},
|
|
28074
|
+
},
|
|
28075
|
+
required: [
|
|
28076
|
+
'message',
|
|
28077
|
+
'is_device_error',
|
|
28078
|
+
'created_at',
|
|
28079
|
+
'error_code',
|
|
28080
|
+
],
|
|
28081
|
+
type: 'object',
|
|
28082
|
+
'x-resource-type': 'device',
|
|
28083
|
+
},
|
|
28084
|
+
{
|
|
28085
|
+
description: 'Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.',
|
|
28086
|
+
properties: {
|
|
28087
|
+
created_at: {
|
|
28088
|
+
description: 'Date and time at which Seam created the error.',
|
|
28089
|
+
format: 'date-time',
|
|
28090
|
+
type: 'string',
|
|
28091
|
+
},
|
|
28092
|
+
error_code: {
|
|
28093
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28094
|
+
enum: ['empty_backup_access_code_pool'],
|
|
28095
|
+
type: 'string',
|
|
28096
|
+
},
|
|
28097
|
+
is_device_error: {
|
|
28098
|
+
description: 'Indicates that the error is a device error.',
|
|
28099
|
+
enum: [true],
|
|
28100
|
+
type: 'boolean',
|
|
28101
|
+
},
|
|
28102
|
+
message: {
|
|
28103
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28104
|
+
type: 'string',
|
|
28105
|
+
},
|
|
28106
|
+
},
|
|
28107
|
+
required: [
|
|
28108
|
+
'message',
|
|
28109
|
+
'is_device_error',
|
|
28110
|
+
'created_at',
|
|
28111
|
+
'error_code',
|
|
28112
|
+
],
|
|
28113
|
+
type: 'object',
|
|
28114
|
+
'x-resource-type': 'device',
|
|
28115
|
+
'x-variant-group-key': 'access_codes',
|
|
28116
|
+
},
|
|
28117
|
+
{
|
|
28118
|
+
description: 'Indicates that the user is not authorized to use the August lock.',
|
|
28119
|
+
properties: {
|
|
28120
|
+
created_at: {
|
|
28121
|
+
description: 'Date and time at which Seam created the error.',
|
|
28122
|
+
format: 'date-time',
|
|
28123
|
+
type: 'string',
|
|
28124
|
+
},
|
|
28125
|
+
error_code: {
|
|
28126
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28127
|
+
enum: ['august_lock_not_authorized'],
|
|
28128
|
+
type: 'string',
|
|
28129
|
+
},
|
|
28130
|
+
is_device_error: {
|
|
28131
|
+
description: 'Indicates that the error is a device error.',
|
|
28132
|
+
enum: [true],
|
|
28133
|
+
type: 'boolean',
|
|
28134
|
+
},
|
|
28135
|
+
message: {
|
|
28136
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28137
|
+
type: 'string',
|
|
28138
|
+
},
|
|
28139
|
+
},
|
|
28140
|
+
required: [
|
|
28141
|
+
'message',
|
|
28142
|
+
'is_device_error',
|
|
28143
|
+
'created_at',
|
|
28144
|
+
'error_code',
|
|
28145
|
+
],
|
|
28146
|
+
type: 'object',
|
|
28147
|
+
'x-resource-type': 'device',
|
|
28148
|
+
'x-variant-group-key': 'locks',
|
|
28149
|
+
},
|
|
28150
|
+
{
|
|
28151
|
+
description: 'Indicates that device credentials are missing.',
|
|
28152
|
+
properties: {
|
|
28153
|
+
created_at: {
|
|
28154
|
+
description: 'Date and time at which Seam created the error.',
|
|
28155
|
+
format: 'date-time',
|
|
28156
|
+
type: 'string',
|
|
28157
|
+
},
|
|
28158
|
+
error_code: {
|
|
28159
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28160
|
+
enum: ['missing_device_credentials'],
|
|
28161
|
+
type: 'string',
|
|
28162
|
+
},
|
|
28163
|
+
is_device_error: {
|
|
28164
|
+
description: 'Indicates that the error is a device error.',
|
|
28165
|
+
enum: [true],
|
|
28166
|
+
type: 'boolean',
|
|
28167
|
+
},
|
|
28168
|
+
message: {
|
|
28169
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28170
|
+
type: 'string',
|
|
28171
|
+
},
|
|
28172
|
+
},
|
|
28173
|
+
required: [
|
|
28174
|
+
'message',
|
|
28175
|
+
'is_device_error',
|
|
28176
|
+
'created_at',
|
|
28177
|
+
'error_code',
|
|
28178
|
+
],
|
|
28179
|
+
type: 'object',
|
|
28180
|
+
'x-resource-type': 'device',
|
|
28181
|
+
},
|
|
28182
|
+
{
|
|
28183
|
+
description: 'Indicates that the auxiliary heat is running.',
|
|
28184
|
+
properties: {
|
|
28185
|
+
created_at: {
|
|
28186
|
+
description: 'Date and time at which Seam created the error.',
|
|
28187
|
+
format: 'date-time',
|
|
28188
|
+
type: 'string',
|
|
28189
|
+
},
|
|
28190
|
+
error_code: {
|
|
28191
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28192
|
+
enum: ['auxiliary_heat_running'],
|
|
28193
|
+
type: 'string',
|
|
28194
|
+
},
|
|
28195
|
+
is_device_error: {
|
|
28196
|
+
description: 'Indicates that the error is a device error.',
|
|
28197
|
+
enum: [true],
|
|
28198
|
+
type: 'boolean',
|
|
28199
|
+
},
|
|
28200
|
+
message: {
|
|
28201
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28202
|
+
type: 'string',
|
|
28203
|
+
},
|
|
28204
|
+
},
|
|
28205
|
+
required: [
|
|
28206
|
+
'message',
|
|
28207
|
+
'is_device_error',
|
|
28208
|
+
'created_at',
|
|
28209
|
+
'error_code',
|
|
28210
|
+
],
|
|
28211
|
+
type: 'object',
|
|
28212
|
+
'x-resource-type': 'device',
|
|
28213
|
+
'x-variant-group-key': 'thermostats',
|
|
28214
|
+
},
|
|
28215
|
+
{
|
|
28216
|
+
description: 'Indicates that a subscription is required to connect.',
|
|
28217
|
+
properties: {
|
|
28218
|
+
created_at: {
|
|
28219
|
+
description: 'Date and time at which Seam created the error.',
|
|
28220
|
+
format: 'date-time',
|
|
28221
|
+
type: 'string',
|
|
28222
|
+
},
|
|
28223
|
+
error_code: {
|
|
28224
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28225
|
+
enum: ['subscription_required'],
|
|
28226
|
+
type: 'string',
|
|
28227
|
+
},
|
|
28228
|
+
is_device_error: {
|
|
28229
|
+
description: 'Indicates that the error is a device error.',
|
|
28230
|
+
enum: [true],
|
|
28231
|
+
type: 'boolean',
|
|
28232
|
+
},
|
|
28233
|
+
message: {
|
|
28234
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28235
|
+
type: 'string',
|
|
28236
|
+
},
|
|
28237
|
+
},
|
|
28238
|
+
required: [
|
|
28239
|
+
'message',
|
|
28240
|
+
'is_device_error',
|
|
28241
|
+
'created_at',
|
|
28242
|
+
'error_code',
|
|
28243
|
+
],
|
|
28244
|
+
type: 'object',
|
|
28245
|
+
'x-resource-type': 'device',
|
|
28246
|
+
},
|
|
28247
|
+
{
|
|
28248
|
+
description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
28249
|
+
properties: {
|
|
28250
|
+
created_at: {
|
|
28251
|
+
description: 'Date and time at which Seam created the error.',
|
|
28252
|
+
format: 'date-time',
|
|
28253
|
+
type: 'string',
|
|
28254
|
+
},
|
|
28255
|
+
error_code: {
|
|
28256
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28257
|
+
enum: ['bridge_disconnected'],
|
|
28258
|
+
type: 'string',
|
|
28259
|
+
},
|
|
28260
|
+
is_bridge_error: {
|
|
28261
|
+
description: 'Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).',
|
|
28262
|
+
type: 'boolean',
|
|
28263
|
+
},
|
|
28264
|
+
is_connected_account_error: {
|
|
28265
|
+
description: 'Indicates whether the error is related specifically to the connected account.',
|
|
28266
|
+
type: 'boolean',
|
|
28267
|
+
},
|
|
28268
|
+
message: {
|
|
28269
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28270
|
+
type: 'string',
|
|
28271
|
+
},
|
|
28272
|
+
},
|
|
28273
|
+
required: ['created_at', 'message', 'error_code'],
|
|
28274
|
+
type: 'object',
|
|
28275
|
+
'x-resource-type': 'connected_account',
|
|
28276
|
+
},
|
|
28277
|
+
],
|
|
28278
|
+
},
|
|
28279
|
+
type: 'array',
|
|
28280
|
+
'x-variant-groups': {
|
|
28281
|
+
access_codes: { name: 'Access Codes' },
|
|
28282
|
+
hardware: { name: 'Hardware' },
|
|
28283
|
+
locks: { name: 'Locks' },
|
|
28284
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
28285
|
+
phones: { name: 'Phones' },
|
|
28286
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
28287
|
+
thermostats: { name: 'Thermostats' },
|
|
28288
|
+
},
|
|
28289
|
+
},
|
|
28290
|
+
nickname: {
|
|
28291
|
+
description: 'Optional nickname to describe the phone, settable through Seam.\n ',
|
|
28292
|
+
type: 'string',
|
|
28293
|
+
},
|
|
28294
|
+
properties: {
|
|
28295
|
+
description: 'Properties of the phone.',
|
|
28296
|
+
properties: {
|
|
28297
|
+
assa_abloy_credential_service_metadata: {
|
|
28298
|
+
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
28299
|
+
properties: {
|
|
28300
|
+
endpoints: {
|
|
28301
|
+
description: 'Endpoints associated with the phone.',
|
|
28302
|
+
items: {
|
|
28303
|
+
properties: {
|
|
28304
|
+
endpoint_id: {
|
|
28305
|
+
description: 'ID of the associated endpoint.',
|
|
28306
|
+
type: 'string',
|
|
28307
|
+
},
|
|
28308
|
+
is_active: {
|
|
28309
|
+
description: 'Indicated whether the endpoint is active.',
|
|
28310
|
+
type: 'boolean',
|
|
28311
|
+
},
|
|
28312
|
+
},
|
|
28313
|
+
type: 'object',
|
|
28314
|
+
},
|
|
28315
|
+
type: 'array',
|
|
28316
|
+
},
|
|
28317
|
+
has_active_endpoint: {
|
|
28318
|
+
description: 'Indicates whether the credential service has active endpoints associated with the phone.',
|
|
28319
|
+
type: 'boolean',
|
|
28320
|
+
},
|
|
28321
|
+
},
|
|
28322
|
+
type: 'object',
|
|
28323
|
+
},
|
|
28324
|
+
salto_space_credential_service_metadata: {
|
|
28325
|
+
description: 'Salto Space credential service metadata for the phone.',
|
|
28326
|
+
properties: {
|
|
28327
|
+
has_active_phone: {
|
|
28328
|
+
description: 'Indicates whether the credential service has an active associated phone.',
|
|
28329
|
+
type: 'boolean',
|
|
28330
|
+
},
|
|
28331
|
+
},
|
|
28332
|
+
type: 'object',
|
|
28333
|
+
},
|
|
28334
|
+
},
|
|
28335
|
+
type: 'object',
|
|
28336
|
+
},
|
|
28337
|
+
warnings: {
|
|
28338
|
+
description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
28339
|
+
items: {
|
|
28340
|
+
discriminator: { propertyName: 'warning_code' },
|
|
28341
|
+
oneOf: [
|
|
28342
|
+
{
|
|
28343
|
+
description: 'Indicates that the backup access code is unhealthy.',
|
|
28344
|
+
properties: {
|
|
28345
|
+
created_at: {
|
|
28346
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28347
|
+
format: 'date-time',
|
|
28348
|
+
type: 'string',
|
|
28349
|
+
},
|
|
28350
|
+
message: {
|
|
28351
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28352
|
+
type: 'string',
|
|
28353
|
+
},
|
|
28354
|
+
warning_code: {
|
|
28355
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28356
|
+
enum: ['partial_backup_access_code_pool'],
|
|
28357
|
+
type: 'string',
|
|
28358
|
+
},
|
|
28359
|
+
},
|
|
28360
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28361
|
+
type: 'object',
|
|
28362
|
+
'x-variant-group-key': 'access_codes',
|
|
28363
|
+
},
|
|
28364
|
+
{
|
|
28365
|
+
description: 'Indicates that there are too many backup codes.',
|
|
28366
|
+
properties: {
|
|
28367
|
+
created_at: {
|
|
28368
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28369
|
+
format: 'date-time',
|
|
28370
|
+
type: 'string',
|
|
28371
|
+
},
|
|
28372
|
+
message: {
|
|
28373
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28374
|
+
type: 'string',
|
|
28375
|
+
},
|
|
28376
|
+
warning_code: {
|
|
28377
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28378
|
+
enum: ['many_active_backup_codes'],
|
|
28379
|
+
type: 'string',
|
|
28380
|
+
},
|
|
28381
|
+
},
|
|
28382
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28383
|
+
type: 'object',
|
|
28384
|
+
'x-variant-group-key': 'access_codes',
|
|
28385
|
+
},
|
|
28386
|
+
{
|
|
28387
|
+
description: 'Indicates that a third-party integration has been detected.',
|
|
28388
|
+
properties: {
|
|
28389
|
+
created_at: {
|
|
28390
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28391
|
+
format: 'date-time',
|
|
28392
|
+
type: 'string',
|
|
28393
|
+
},
|
|
28394
|
+
message: {
|
|
28395
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28396
|
+
type: 'string',
|
|
28397
|
+
},
|
|
28398
|
+
warning_code: {
|
|
28399
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28400
|
+
enum: ['third_party_integration_detected'],
|
|
28401
|
+
type: 'string',
|
|
28402
|
+
},
|
|
28403
|
+
},
|
|
28404
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28405
|
+
type: 'object',
|
|
28406
|
+
},
|
|
28407
|
+
{
|
|
28408
|
+
description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
|
|
28409
|
+
properties: {
|
|
28410
|
+
created_at: {
|
|
28411
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28412
|
+
format: 'date-time',
|
|
28413
|
+
type: 'string',
|
|
28414
|
+
},
|
|
28415
|
+
message: {
|
|
28416
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28417
|
+
type: 'string',
|
|
28418
|
+
},
|
|
28419
|
+
warning_code: {
|
|
28420
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28421
|
+
enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
|
|
28422
|
+
type: 'string',
|
|
28423
|
+
},
|
|
28424
|
+
},
|
|
28425
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28426
|
+
type: 'object',
|
|
28427
|
+
'x-variant-group-key': 'locks',
|
|
28428
|
+
},
|
|
28429
|
+
{
|
|
28430
|
+
description: 'Indicates that the gateway signal is weak.',
|
|
28431
|
+
properties: {
|
|
28432
|
+
created_at: {
|
|
28433
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28434
|
+
format: 'date-time',
|
|
28435
|
+
type: 'string',
|
|
28436
|
+
},
|
|
28437
|
+
message: {
|
|
28438
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28439
|
+
type: 'string',
|
|
28440
|
+
},
|
|
28441
|
+
warning_code: {
|
|
28442
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28443
|
+
enum: ['ttlock_weak_gateway_signal'],
|
|
28444
|
+
type: 'string',
|
|
28445
|
+
},
|
|
28446
|
+
},
|
|
28447
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28448
|
+
type: 'object',
|
|
28449
|
+
'x-variant-group-key': 'locks',
|
|
28450
|
+
},
|
|
28451
|
+
{
|
|
28452
|
+
description: 'Indicates that the device is in power saving mode and may have limited functionality.',
|
|
28453
|
+
properties: {
|
|
28454
|
+
created_at: {
|
|
28455
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28456
|
+
format: 'date-time',
|
|
28457
|
+
type: 'string',
|
|
28458
|
+
},
|
|
28459
|
+
message: {
|
|
28460
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28461
|
+
type: 'string',
|
|
28462
|
+
},
|
|
28463
|
+
warning_code: {
|
|
28464
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28465
|
+
enum: ['power_saving_mode'],
|
|
28466
|
+
type: 'string',
|
|
28467
|
+
},
|
|
28468
|
+
},
|
|
28469
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28470
|
+
type: 'object',
|
|
28471
|
+
'x-variant-group-key': 'locks',
|
|
28472
|
+
},
|
|
28473
|
+
{
|
|
28474
|
+
description: 'Indicates that the temperature threshold has been exceeded.',
|
|
28475
|
+
properties: {
|
|
28476
|
+
created_at: {
|
|
28477
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28478
|
+
format: 'date-time',
|
|
28479
|
+
type: 'string',
|
|
28480
|
+
},
|
|
28481
|
+
message: {
|
|
28482
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28483
|
+
type: 'string',
|
|
28484
|
+
},
|
|
28485
|
+
warning_code: {
|
|
28486
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28487
|
+
enum: ['temperature_threshold_exceeded'],
|
|
28488
|
+
type: 'string',
|
|
28489
|
+
},
|
|
28490
|
+
},
|
|
28491
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28492
|
+
type: 'object',
|
|
28493
|
+
'x-variant-group-key': 'thermostats',
|
|
28494
|
+
},
|
|
28495
|
+
{
|
|
28496
|
+
description: 'Indicates that the device appears to be unresponsive.',
|
|
28497
|
+
properties: {
|
|
28498
|
+
created_at: {
|
|
28499
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28500
|
+
format: 'date-time',
|
|
28501
|
+
type: 'string',
|
|
28502
|
+
},
|
|
28503
|
+
message: {
|
|
28504
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28505
|
+
type: 'string',
|
|
28506
|
+
},
|
|
28507
|
+
warning_code: {
|
|
28508
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28509
|
+
enum: ['device_communication_degraded'],
|
|
28510
|
+
type: 'string',
|
|
28511
|
+
},
|
|
28512
|
+
},
|
|
28513
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28514
|
+
type: 'object',
|
|
28515
|
+
},
|
|
28516
|
+
{
|
|
28517
|
+
description: 'Indicates that a scheduled maintenance window has been detected.',
|
|
28518
|
+
properties: {
|
|
28519
|
+
created_at: {
|
|
28520
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28521
|
+
format: 'date-time',
|
|
28522
|
+
type: 'string',
|
|
28523
|
+
},
|
|
28524
|
+
message: {
|
|
28525
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28526
|
+
type: 'string',
|
|
28527
|
+
},
|
|
28528
|
+
warning_code: {
|
|
28529
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28530
|
+
enum: ['scheduled_maintenance_window'],
|
|
28531
|
+
type: 'string',
|
|
28532
|
+
},
|
|
28533
|
+
},
|
|
28534
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28535
|
+
type: 'object',
|
|
28536
|
+
},
|
|
28537
|
+
{
|
|
28538
|
+
description: 'Indicates that the device has a flaky connection.',
|
|
28539
|
+
properties: {
|
|
28540
|
+
created_at: {
|
|
28541
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28542
|
+
format: 'date-time',
|
|
28543
|
+
type: 'string',
|
|
28544
|
+
},
|
|
28545
|
+
message: {
|
|
28546
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28547
|
+
type: 'string',
|
|
28548
|
+
},
|
|
28549
|
+
warning_code: {
|
|
28550
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28551
|
+
enum: ['device_has_flaky_connection'],
|
|
28552
|
+
type: 'string',
|
|
28553
|
+
},
|
|
28554
|
+
},
|
|
28555
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28556
|
+
type: 'object',
|
|
28557
|
+
},
|
|
28558
|
+
{
|
|
28559
|
+
description: 'Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.',
|
|
28560
|
+
properties: {
|
|
28561
|
+
created_at: {
|
|
28562
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28563
|
+
format: 'date-time',
|
|
28564
|
+
type: 'string',
|
|
28565
|
+
},
|
|
28566
|
+
message: {
|
|
28567
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28568
|
+
type: 'string',
|
|
28569
|
+
},
|
|
28570
|
+
warning_code: {
|
|
28571
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28572
|
+
enum: ['salto_ks_office_mode'],
|
|
28573
|
+
type: 'string',
|
|
28574
|
+
},
|
|
28575
|
+
},
|
|
28576
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28577
|
+
type: 'object',
|
|
28578
|
+
'x-variant-group-key': 'access_codes',
|
|
27097
28579
|
},
|
|
27098
|
-
|
|
27099
|
-
|
|
27100
|
-
|
|
28580
|
+
{
|
|
28581
|
+
deprecated: true,
|
|
28582
|
+
description: 'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.',
|
|
28583
|
+
properties: {
|
|
28584
|
+
created_at: {
|
|
28585
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28586
|
+
format: 'date-time',
|
|
28587
|
+
type: 'string',
|
|
28588
|
+
},
|
|
28589
|
+
message: {
|
|
28590
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28591
|
+
type: 'string',
|
|
28592
|
+
},
|
|
28593
|
+
warning_code: {
|
|
28594
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28595
|
+
enum: ['salto_ks_privacy_mode'],
|
|
28596
|
+
type: 'string',
|
|
28597
|
+
},
|
|
28598
|
+
},
|
|
28599
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28600
|
+
type: 'object',
|
|
28601
|
+
'x-deprecated': 'Use `privacy_mode` instead.',
|
|
28602
|
+
'x-variant-group-key': 'access_codes',
|
|
27101
28603
|
},
|
|
27102
|
-
|
|
27103
|
-
description: '
|
|
27104
|
-
|
|
28604
|
+
{
|
|
28605
|
+
description: 'Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.',
|
|
28606
|
+
properties: {
|
|
28607
|
+
created_at: {
|
|
28608
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28609
|
+
format: 'date-time',
|
|
28610
|
+
type: 'string',
|
|
28611
|
+
},
|
|
28612
|
+
message: {
|
|
28613
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28614
|
+
type: 'string',
|
|
28615
|
+
},
|
|
28616
|
+
warning_code: {
|
|
28617
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28618
|
+
enum: ['privacy_mode'],
|
|
28619
|
+
type: 'string',
|
|
28620
|
+
},
|
|
28621
|
+
},
|
|
28622
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28623
|
+
type: 'object',
|
|
28624
|
+
'x-variant-group-key': 'access_codes',
|
|
27105
28625
|
},
|
|
27106
|
-
|
|
27107
|
-
|
|
27108
|
-
|
|
27109
|
-
|
|
27110
|
-
|
|
27111
|
-
|
|
27112
|
-
|
|
27113
|
-
|
|
27114
|
-
|
|
27115
|
-
|
|
27116
|
-
|
|
27117
|
-
|
|
27118
|
-
|
|
27119
|
-
|
|
27120
|
-
|
|
27121
|
-
|
|
27122
|
-
endpoints: {
|
|
27123
|
-
description: 'Endpoints associated with the phone.',
|
|
27124
|
-
items: {
|
|
27125
|
-
properties: {
|
|
27126
|
-
endpoint_id: {
|
|
27127
|
-
description: 'ID of the associated endpoint.',
|
|
27128
|
-
type: 'string',
|
|
27129
|
-
},
|
|
27130
|
-
is_active: {
|
|
27131
|
-
description: 'Indicated whether the endpoint is active.',
|
|
27132
|
-
type: 'boolean',
|
|
27133
|
-
},
|
|
27134
|
-
},
|
|
27135
|
-
type: 'object',
|
|
28626
|
+
{
|
|
28627
|
+
description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.',
|
|
28628
|
+
properties: {
|
|
28629
|
+
created_at: {
|
|
28630
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28631
|
+
format: 'date-time',
|
|
28632
|
+
type: 'string',
|
|
28633
|
+
},
|
|
28634
|
+
message: {
|
|
28635
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28636
|
+
type: 'string',
|
|
28637
|
+
},
|
|
28638
|
+
warning_code: {
|
|
28639
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28640
|
+
enum: ['salto_ks_subscription_limit_almost_reached'],
|
|
28641
|
+
type: 'string',
|
|
27136
28642
|
},
|
|
27137
|
-
type: 'array',
|
|
27138
28643
|
},
|
|
27139
|
-
|
|
27140
|
-
|
|
27141
|
-
|
|
28644
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28645
|
+
type: 'object',
|
|
28646
|
+
'x-variant-group-key': 'locks',
|
|
28647
|
+
},
|
|
28648
|
+
{
|
|
28649
|
+
description: 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
|
|
28650
|
+
properties: {
|
|
28651
|
+
created_at: {
|
|
28652
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28653
|
+
format: 'date-time',
|
|
28654
|
+
type: 'string',
|
|
28655
|
+
},
|
|
28656
|
+
message: {
|
|
28657
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28658
|
+
type: 'string',
|
|
28659
|
+
},
|
|
28660
|
+
warning_code: {
|
|
28661
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28662
|
+
enum: ['salto_ks_lock_access_code_support_removed'],
|
|
28663
|
+
type: 'string',
|
|
28664
|
+
},
|
|
27142
28665
|
},
|
|
28666
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28667
|
+
type: 'object',
|
|
28668
|
+
'x-variant-group-key': 'access_codes',
|
|
27143
28669
|
},
|
|
27144
|
-
|
|
27145
|
-
|
|
27146
|
-
|
|
27147
|
-
|
|
27148
|
-
|
|
27149
|
-
|
|
27150
|
-
|
|
27151
|
-
|
|
28670
|
+
{
|
|
28671
|
+
description: 'Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.',
|
|
28672
|
+
properties: {
|
|
28673
|
+
created_at: {
|
|
28674
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28675
|
+
format: 'date-time',
|
|
28676
|
+
type: 'string',
|
|
28677
|
+
},
|
|
28678
|
+
message: {
|
|
28679
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28680
|
+
type: 'string',
|
|
28681
|
+
},
|
|
28682
|
+
warning_code: {
|
|
28683
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28684
|
+
enum: ['unknown_issue_with_phone'],
|
|
28685
|
+
type: 'string',
|
|
28686
|
+
},
|
|
27152
28687
|
},
|
|
28688
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28689
|
+
type: 'object',
|
|
28690
|
+
'x-variant-group-key': 'phones',
|
|
27153
28691
|
},
|
|
27154
|
-
|
|
27155
|
-
|
|
27156
|
-
|
|
27157
|
-
|
|
27158
|
-
|
|
27159
|
-
|
|
27160
|
-
|
|
27161
|
-
|
|
27162
|
-
|
|
27163
|
-
|
|
27164
|
-
|
|
27165
|
-
|
|
27166
|
-
|
|
28692
|
+
{
|
|
28693
|
+
description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
|
|
28694
|
+
properties: {
|
|
28695
|
+
created_at: {
|
|
28696
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28697
|
+
format: 'date-time',
|
|
28698
|
+
type: 'string',
|
|
28699
|
+
},
|
|
28700
|
+
message: {
|
|
28701
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28702
|
+
type: 'string',
|
|
28703
|
+
},
|
|
28704
|
+
warning_code: {
|
|
28705
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28706
|
+
enum: ['lockly_time_zone_not_configured'],
|
|
28707
|
+
type: 'string',
|
|
28708
|
+
},
|
|
28709
|
+
},
|
|
28710
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28711
|
+
type: 'object',
|
|
28712
|
+
'x-variant-group-key': 'locks',
|
|
27167
28713
|
},
|
|
27168
|
-
|
|
27169
|
-
description: '
|
|
27170
|
-
|
|
28714
|
+
{
|
|
28715
|
+
description: 'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.',
|
|
28716
|
+
properties: {
|
|
28717
|
+
created_at: {
|
|
28718
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28719
|
+
format: 'date-time',
|
|
28720
|
+
type: 'string',
|
|
28721
|
+
},
|
|
28722
|
+
message: {
|
|
28723
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28724
|
+
type: 'string',
|
|
28725
|
+
},
|
|
28726
|
+
warning_code: {
|
|
28727
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28728
|
+
enum: ['ultraloq_time_zone_unknown'],
|
|
28729
|
+
type: 'string',
|
|
28730
|
+
},
|
|
28731
|
+
},
|
|
28732
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28733
|
+
type: 'object',
|
|
28734
|
+
'x-variant-group-key': 'locks',
|
|
27171
28735
|
},
|
|
27172
|
-
|
|
27173
|
-
description:
|
|
27174
|
-
|
|
28736
|
+
{
|
|
28737
|
+
description: "Indicates that Seam does not know the device's time zone. Set a time zone to enable time-bound access codes.",
|
|
28738
|
+
properties: {
|
|
28739
|
+
created_at: {
|
|
28740
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28741
|
+
format: 'date-time',
|
|
28742
|
+
type: 'string',
|
|
28743
|
+
},
|
|
28744
|
+
message: {
|
|
28745
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28746
|
+
type: 'string',
|
|
28747
|
+
},
|
|
28748
|
+
warning_code: {
|
|
28749
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28750
|
+
enum: ['time_zone_unknown'],
|
|
28751
|
+
type: 'string',
|
|
28752
|
+
},
|
|
28753
|
+
},
|
|
28754
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28755
|
+
type: 'object',
|
|
28756
|
+
'x-variant-group-key': 'locks',
|
|
27175
28757
|
},
|
|
27176
|
-
|
|
27177
|
-
|
|
27178
|
-
|
|
28758
|
+
{
|
|
28759
|
+
description: "Indicates that the device's configured time zone does not match its hardware UTC offset. Time-bound access codes may activate at the wrong local time.",
|
|
28760
|
+
properties: {
|
|
28761
|
+
created_at: {
|
|
28762
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28763
|
+
format: 'date-time',
|
|
28764
|
+
type: 'string',
|
|
28765
|
+
},
|
|
28766
|
+
message: {
|
|
28767
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28768
|
+
type: 'string',
|
|
28769
|
+
},
|
|
28770
|
+
warning_code: {
|
|
28771
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28772
|
+
enum: ['time_zone_mismatch'],
|
|
28773
|
+
type: 'string',
|
|
28774
|
+
},
|
|
28775
|
+
},
|
|
28776
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28777
|
+
type: 'object',
|
|
28778
|
+
'x-variant-group-key': 'locks',
|
|
28779
|
+
},
|
|
28780
|
+
{
|
|
28781
|
+
description: 'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.',
|
|
28782
|
+
properties: {
|
|
28783
|
+
created_at: {
|
|
28784
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28785
|
+
format: 'date-time',
|
|
28786
|
+
type: 'string',
|
|
28787
|
+
},
|
|
28788
|
+
message: {
|
|
28789
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28790
|
+
type: 'string',
|
|
28791
|
+
},
|
|
28792
|
+
warning_code: {
|
|
28793
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28794
|
+
enum: ['two_n_device_missing_timezone'],
|
|
28795
|
+
type: 'string',
|
|
28796
|
+
},
|
|
28797
|
+
},
|
|
28798
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28799
|
+
type: 'object',
|
|
28800
|
+
'x-variant-group-key': 'locks',
|
|
28801
|
+
},
|
|
28802
|
+
{
|
|
28803
|
+
description: 'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',
|
|
28804
|
+
properties: {
|
|
28805
|
+
created_at: {
|
|
28806
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28807
|
+
format: 'date-time',
|
|
28808
|
+
type: 'string',
|
|
28809
|
+
},
|
|
28810
|
+
message: {
|
|
28811
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28812
|
+
type: 'string',
|
|
28813
|
+
},
|
|
28814
|
+
warning_code: {
|
|
28815
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28816
|
+
enum: ['hub_required_for_additional_capabilities'],
|
|
28817
|
+
type: 'string',
|
|
28818
|
+
},
|
|
28819
|
+
},
|
|
28820
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28821
|
+
type: 'object',
|
|
28822
|
+
'x-variant-group-key': 'locks',
|
|
28823
|
+
},
|
|
28824
|
+
{
|
|
28825
|
+
description: 'Indicates a provider-specific issue that may affect device functionality.',
|
|
28826
|
+
properties: {
|
|
28827
|
+
created_at: {
|
|
28828
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28829
|
+
format: 'date-time',
|
|
28830
|
+
type: 'string',
|
|
28831
|
+
},
|
|
28832
|
+
message: {
|
|
28833
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28834
|
+
type: 'string',
|
|
28835
|
+
},
|
|
28836
|
+
warning_code: {
|
|
28837
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28838
|
+
enum: ['provider_issue'],
|
|
28839
|
+
type: 'string',
|
|
28840
|
+
},
|
|
28841
|
+
},
|
|
28842
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28843
|
+
type: 'object',
|
|
28844
|
+
'x-variant-group-key': 'access_codes',
|
|
28845
|
+
},
|
|
28846
|
+
{
|
|
28847
|
+
description: 'Indicates that the key is in a locker that does not support the access codes API.',
|
|
28848
|
+
properties: {
|
|
28849
|
+
created_at: {
|
|
28850
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28851
|
+
format: 'date-time',
|
|
28852
|
+
type: 'string',
|
|
28853
|
+
},
|
|
28854
|
+
message: {
|
|
28855
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28856
|
+
type: 'string',
|
|
28857
|
+
},
|
|
28858
|
+
warning_code: {
|
|
28859
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28860
|
+
enum: ['keynest_unsupported_locker'],
|
|
28861
|
+
type: 'string',
|
|
28862
|
+
},
|
|
28863
|
+
},
|
|
28864
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28865
|
+
type: 'object',
|
|
28866
|
+
'x-variant-group-key': 'locks',
|
|
28867
|
+
},
|
|
28868
|
+
{
|
|
28869
|
+
description: 'Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.',
|
|
28870
|
+
properties: {
|
|
28871
|
+
created_at: {
|
|
28872
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28873
|
+
format: 'date-time',
|
|
28874
|
+
type: 'string',
|
|
28875
|
+
},
|
|
28876
|
+
message: {
|
|
28877
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28878
|
+
type: 'string',
|
|
28879
|
+
},
|
|
28880
|
+
warning_code: {
|
|
28881
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28882
|
+
enum: ['accessory_keypad_setup_required'],
|
|
28883
|
+
type: 'string',
|
|
28884
|
+
},
|
|
28885
|
+
},
|
|
28886
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28887
|
+
type: 'object',
|
|
28888
|
+
'x-variant-group-key': 'locks',
|
|
28889
|
+
},
|
|
28890
|
+
{
|
|
28891
|
+
description: 'Indicates that the accessory keypad paired with this lock has a low or critically low battery. Replace its batteries so guests can keep entering their access codes.',
|
|
28892
|
+
properties: {
|
|
28893
|
+
created_at: {
|
|
28894
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28895
|
+
format: 'date-time',
|
|
28896
|
+
type: 'string',
|
|
28897
|
+
},
|
|
28898
|
+
message: {
|
|
28899
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28900
|
+
type: 'string',
|
|
28901
|
+
},
|
|
28902
|
+
warning_code: {
|
|
28903
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28904
|
+
enum: ['accessory_keypad_low_battery'],
|
|
28905
|
+
type: 'string',
|
|
28906
|
+
},
|
|
28907
|
+
},
|
|
28908
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28909
|
+
type: 'object',
|
|
28910
|
+
'x-variant-group-key': 'locks',
|
|
28911
|
+
},
|
|
28912
|
+
{
|
|
28913
|
+
description: 'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.',
|
|
28914
|
+
properties: {
|
|
28915
|
+
created_at: {
|
|
28916
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28917
|
+
format: 'date-time',
|
|
28918
|
+
type: 'string',
|
|
28919
|
+
},
|
|
28920
|
+
message: {
|
|
28921
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28922
|
+
type: 'string',
|
|
28923
|
+
},
|
|
28924
|
+
warning_code: {
|
|
28925
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28926
|
+
enum: ['unreliable_online_status'],
|
|
28927
|
+
type: 'string',
|
|
28928
|
+
},
|
|
28929
|
+
},
|
|
28930
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
28931
|
+
type: 'object',
|
|
28932
|
+
'x-variant-group-key': 'locks',
|
|
28933
|
+
},
|
|
28934
|
+
{
|
|
28935
|
+
description: 'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.',
|
|
28936
|
+
properties: {
|
|
28937
|
+
active_access_code_count: {
|
|
28938
|
+
description: 'Number of active access codes on the device when the warning was set.',
|
|
28939
|
+
type: 'integer',
|
|
28940
|
+
},
|
|
28941
|
+
created_at: {
|
|
28942
|
+
description: 'Date and time at which Seam created the warning.',
|
|
28943
|
+
format: 'date-time',
|
|
28944
|
+
type: 'string',
|
|
28945
|
+
},
|
|
28946
|
+
max_active_access_code_count: {
|
|
28947
|
+
description: 'Maximum number of active access codes supported by the device.',
|
|
28948
|
+
type: 'integer',
|
|
28949
|
+
},
|
|
28950
|
+
message: {
|
|
28951
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
28952
|
+
type: 'string',
|
|
28953
|
+
},
|
|
28954
|
+
warning_code: {
|
|
28955
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
28956
|
+
enum: ['max_access_codes_reached'],
|
|
28957
|
+
type: 'string',
|
|
28958
|
+
},
|
|
28959
|
+
},
|
|
28960
|
+
required: [
|
|
28961
|
+
'message',
|
|
28962
|
+
'created_at',
|
|
28963
|
+
'warning_code',
|
|
28964
|
+
'active_access_code_count',
|
|
28965
|
+
'max_active_access_code_count',
|
|
28966
|
+
],
|
|
28967
|
+
type: 'object',
|
|
28968
|
+
'x-variant-group-key': 'access_codes',
|
|
28969
|
+
},
|
|
28970
|
+
],
|
|
27179
28971
|
},
|
|
27180
28972
|
type: 'array',
|
|
28973
|
+
'x-variant-groups': {
|
|
28974
|
+
access_codes: { name: 'Access Codes' },
|
|
28975
|
+
hardware: { name: 'Hardware' },
|
|
28976
|
+
locks: { name: 'Locks' },
|
|
28977
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
28978
|
+
phones: { name: 'Phones' },
|
|
28979
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
28980
|
+
thermostats: { name: 'Thermostats' },
|
|
28981
|
+
},
|
|
27181
28982
|
},
|
|
27182
28983
|
workspace_id: {
|
|
27183
28984
|
description: 'ID of the workspace that contains the phone.\n ',
|
|
@@ -27456,27 +29257,36 @@ const openapi = {
|
|
|
27456
29257
|
errors: {
|
|
27457
29258
|
description: 'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
27458
29259
|
items: {
|
|
27459
|
-
|
|
27460
|
-
|
|
27461
|
-
|
|
27462
|
-
|
|
27463
|
-
|
|
27464
|
-
|
|
27465
|
-
|
|
27466
|
-
|
|
27467
|
-
|
|
27468
|
-
|
|
27469
|
-
|
|
27470
|
-
|
|
27471
|
-
|
|
29260
|
+
description: 'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
29261
|
+
discriminator: { propertyName: 'error_code' },
|
|
29262
|
+
oneOf: [
|
|
29263
|
+
{
|
|
29264
|
+
description: 'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
|
|
29265
|
+
properties: {
|
|
29266
|
+
created_at: {
|
|
29267
|
+
description: 'Date and time at which Seam created the error.',
|
|
29268
|
+
format: 'date-time',
|
|
29269
|
+
type: 'string',
|
|
29270
|
+
},
|
|
29271
|
+
error_code: {
|
|
29272
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
29273
|
+
enum: ['entrance_removed'],
|
|
29274
|
+
type: 'string',
|
|
29275
|
+
},
|
|
29276
|
+
message: {
|
|
29277
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
29278
|
+
type: 'string',
|
|
29279
|
+
},
|
|
29280
|
+
},
|
|
29281
|
+
required: [
|
|
29282
|
+
'created_at',
|
|
29283
|
+
'message',
|
|
29284
|
+
'error_code',
|
|
29285
|
+
],
|
|
29286
|
+
type: 'object',
|
|
29287
|
+
'x-resource-type': 'acs_entrance',
|
|
27472
29288
|
},
|
|
27473
|
-
},
|
|
27474
|
-
required: [
|
|
27475
|
-
'error_code',
|
|
27476
|
-
'message',
|
|
27477
|
-
'created_at',
|
|
27478
29289
|
],
|
|
27479
|
-
type: 'object',
|
|
27480
29290
|
},
|
|
27481
29291
|
type: 'array',
|
|
27482
29292
|
},
|
|
@@ -30459,7 +32269,8 @@ const openapi = {
|
|
|
30459
32269
|
type: 'string',
|
|
30460
32270
|
},
|
|
30461
32271
|
error_code: {
|
|
30462
|
-
description: 'Reason the access code could not be revoked
|
|
32272
|
+
description: 'Reason the access code could not be revoked.',
|
|
32273
|
+
enum: ['offline_access_code_not_revocable'],
|
|
30463
32274
|
type: 'string',
|
|
30464
32275
|
},
|
|
30465
32276
|
message: {
|
|
@@ -32904,6 +34715,18 @@ const openapi = {
|
|
|
32904
34715
|
description: 'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
32905
34716
|
type: 'boolean',
|
|
32906
34717
|
},
|
|
34718
|
+
can_mute_speaker: {
|
|
34719
|
+
description: 'Indicates whether the speaker supports muting and unmuting.',
|
|
34720
|
+
type: 'boolean',
|
|
34721
|
+
},
|
|
34722
|
+
can_pause_speaker_playback: {
|
|
34723
|
+
description: 'Indicates whether the speaker supports pausing and resuming playback.',
|
|
34724
|
+
type: 'boolean',
|
|
34725
|
+
},
|
|
34726
|
+
can_play_speaker_chime: {
|
|
34727
|
+
description: 'Indicates whether the speaker supports playing a chime.',
|
|
34728
|
+
type: 'boolean',
|
|
34729
|
+
},
|
|
32907
34730
|
can_program_offline_access_codes: {
|
|
32908
34731
|
description: 'Indicates whether the device supports programming offline access codes.',
|
|
32909
34732
|
type: 'boolean',
|
|
@@ -32936,6 +34759,10 @@ const openapi = {
|
|
|
32936
34759
|
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
32937
34760
|
type: 'boolean',
|
|
32938
34761
|
},
|
|
34762
|
+
can_set_speaker_volume: {
|
|
34763
|
+
description: 'Indicates whether the speaker supports setting its volume.',
|
|
34764
|
+
type: 'boolean',
|
|
34765
|
+
},
|
|
32939
34766
|
can_simulate_connection: {
|
|
32940
34767
|
description: 'Indicates whether the device supports simulating connection in a sandbox.',
|
|
32941
34768
|
type: 'boolean',
|
|
@@ -33087,6 +34914,11 @@ const openapi = {
|
|
|
33087
34914
|
],
|
|
33088
34915
|
type: 'string',
|
|
33089
34916
|
},
|
|
34917
|
+
{
|
|
34918
|
+
description: 'Device type for speakers.',
|
|
34919
|
+
enum: ['sonos_speaker'],
|
|
34920
|
+
type: 'string',
|
|
34921
|
+
},
|
|
33090
34922
|
],
|
|
33091
34923
|
},
|
|
33092
34924
|
display_name: {
|
|
@@ -43127,6 +44959,7 @@ const openapi = {
|
|
|
43127
44959
|
'noise_sensor',
|
|
43128
44960
|
'access_control',
|
|
43129
44961
|
'camera',
|
|
44962
|
+
'speaker',
|
|
43130
44963
|
],
|
|
43131
44964
|
type: 'string',
|
|
43132
44965
|
},
|
|
@@ -43873,6 +45706,7 @@ const openapi = {
|
|
|
43873
45706
|
'noise_sensor',
|
|
43874
45707
|
'access_control',
|
|
43875
45708
|
'camera',
|
|
45709
|
+
'speaker',
|
|
43876
45710
|
],
|
|
43877
45711
|
type: 'string',
|
|
43878
45712
|
},
|
|
@@ -46557,6 +48391,11 @@ const openapi = {
|
|
|
46557
48391
|
],
|
|
46558
48392
|
type: 'string',
|
|
46559
48393
|
},
|
|
48394
|
+
{
|
|
48395
|
+
description: 'Device type for speakers.',
|
|
48396
|
+
enum: ['sonos_speaker'],
|
|
48397
|
+
type: 'string',
|
|
48398
|
+
},
|
|
46560
48399
|
],
|
|
46561
48400
|
},
|
|
46562
48401
|
},
|
|
@@ -46641,6 +48480,11 @@ const openapi = {
|
|
|
46641
48480
|
],
|
|
46642
48481
|
type: 'string',
|
|
46643
48482
|
},
|
|
48483
|
+
{
|
|
48484
|
+
description: 'Device type for speakers.',
|
|
48485
|
+
enum: ['sonos_speaker'],
|
|
48486
|
+
type: 'string',
|
|
48487
|
+
},
|
|
46644
48488
|
],
|
|
46645
48489
|
},
|
|
46646
48490
|
type: 'array',
|
|
@@ -46799,6 +48643,10 @@ const openapi = {
|
|
|
46799
48643
|
'can_simulate_paid_subscription',
|
|
46800
48644
|
'can_configure_auto_lock',
|
|
46801
48645
|
'can_stream_live_video',
|
|
48646
|
+
'can_set_speaker_volume',
|
|
48647
|
+
'can_mute_speaker',
|
|
48648
|
+
'can_pause_speaker_playback',
|
|
48649
|
+
'can_play_speaker_chime',
|
|
46802
48650
|
],
|
|
46803
48651
|
type: 'string',
|
|
46804
48652
|
},
|
|
@@ -46834,6 +48682,10 @@ const openapi = {
|
|
|
46834
48682
|
'can_simulate_paid_subscription',
|
|
46835
48683
|
'can_configure_auto_lock',
|
|
46836
48684
|
'can_stream_live_video',
|
|
48685
|
+
'can_set_speaker_volume',
|
|
48686
|
+
'can_mute_speaker',
|
|
48687
|
+
'can_pause_speaker_playback',
|
|
48688
|
+
'can_play_speaker_chime',
|
|
46837
48689
|
],
|
|
46838
48690
|
type: 'string',
|
|
46839
48691
|
},
|
|
@@ -48845,6 +50697,11 @@ const openapi = {
|
|
|
48845
50697
|
],
|
|
48846
50698
|
type: 'string',
|
|
48847
50699
|
},
|
|
50700
|
+
{
|
|
50701
|
+
description: 'Device type for speakers.',
|
|
50702
|
+
enum: ['sonos_speaker'],
|
|
50703
|
+
type: 'string',
|
|
50704
|
+
},
|
|
48848
50705
|
],
|
|
48849
50706
|
},
|
|
48850
50707
|
},
|
|
@@ -48929,6 +50786,11 @@ const openapi = {
|
|
|
48929
50786
|
],
|
|
48930
50787
|
type: 'string',
|
|
48931
50788
|
},
|
|
50789
|
+
{
|
|
50790
|
+
description: 'Device type for speakers.',
|
|
50791
|
+
enum: ['sonos_speaker'],
|
|
50792
|
+
type: 'string',
|
|
50793
|
+
},
|
|
48932
50794
|
],
|
|
48933
50795
|
},
|
|
48934
50796
|
type: 'array',
|
|
@@ -49056,6 +50918,10 @@ const openapi = {
|
|
|
49056
50918
|
'can_simulate_paid_subscription',
|
|
49057
50919
|
'can_configure_auto_lock',
|
|
49058
50920
|
'can_stream_live_video',
|
|
50921
|
+
'can_set_speaker_volume',
|
|
50922
|
+
'can_mute_speaker',
|
|
50923
|
+
'can_pause_speaker_playback',
|
|
50924
|
+
'can_play_speaker_chime',
|
|
49059
50925
|
],
|
|
49060
50926
|
type: 'string',
|
|
49061
50927
|
},
|
|
@@ -49091,6 +50957,10 @@ const openapi = {
|
|
|
49091
50957
|
'can_simulate_paid_subscription',
|
|
49092
50958
|
'can_configure_auto_lock',
|
|
49093
50959
|
'can_stream_live_video',
|
|
50960
|
+
'can_set_speaker_volume',
|
|
50961
|
+
'can_mute_speaker',
|
|
50962
|
+
'can_pause_speaker_playback',
|
|
50963
|
+
'can_play_speaker_chime',
|
|
49094
50964
|
],
|
|
49095
50965
|
type: 'string',
|
|
49096
50966
|
},
|