@seamapi/types 1.1125.0 → 1.1127.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/action-attempts/action-attempt.d.ts +160 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js +26 -14
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.js +43 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js +26 -14
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/play-speaker-favorite.d.ts +87 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-favorite.js +49 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-favorite.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js +26 -14
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js +26 -14
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js +26 -14
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/speaker.js +2 -1
- package/lib/seam/connect/models/devices/capability-properties/speaker.js.map +1 -1
- package/lib/seam/connect/models/devices/device-metadata.js +6 -2
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +6 -0
- package/lib/seam/connect/models/devices/device.d.ts +12 -0
- package/lib/seam/connect/models/devices/device.js +48 -18
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +8 -0
- package/lib/seam/connect/openapi.js +651 -1
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +7428 -36
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -0
- package/src/lib/seam/connect/models/action-attempts/pause-speaker-playback.ts +29 -19
- package/src/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.ts +56 -0
- package/src/lib/seam/connect/models/action-attempts/play-speaker-chime.ts +29 -19
- package/src/lib/seam/connect/models/action-attempts/play-speaker-favorite.ts +64 -0
- package/src/lib/seam/connect/models/action-attempts/resume-speaker-playback.ts +29 -19
- package/src/lib/seam/connect/models/action-attempts/set-speaker-mute.ts +29 -19
- package/src/lib/seam/connect/models/action-attempts/set-speaker-volume.ts +29 -19
- package/src/lib/seam/connect/models/devices/capability-properties/speaker.ts +4 -1
- package/src/lib/seam/connect/models/devices/device-metadata.ts +6 -2
- package/src/lib/seam/connect/models/devices/device.ts +48 -18
- package/src/lib/seam/connect/openapi.ts +691 -1
- package/src/lib/seam/connect/route-types.ts +8353 -21
|
@@ -11869,6 +11869,7 @@ const openapi: OpenAPISpec = {
|
|
|
11869
11869
|
'Action attempt to track the status of setting the volume on a speaker.',
|
|
11870
11870
|
enum: ['SET_SPEAKER_VOLUME'],
|
|
11871
11871
|
type: 'string',
|
|
11872
|
+
'x-undocumented': 'Unreleased.',
|
|
11872
11873
|
},
|
|
11873
11874
|
error: {
|
|
11874
11875
|
description:
|
|
@@ -11890,6 +11891,7 @@ const openapi: OpenAPISpec = {
|
|
|
11890
11891
|
'action_type',
|
|
11891
11892
|
],
|
|
11892
11893
|
type: 'object',
|
|
11894
|
+
'x-undocumented': 'Unreleased.',
|
|
11893
11895
|
},
|
|
11894
11896
|
{
|
|
11895
11897
|
description: 'Setting the speaker volume succeeded.',
|
|
@@ -11904,6 +11906,7 @@ const openapi: OpenAPISpec = {
|
|
|
11904
11906
|
'Action attempt to track the status of setting the volume on a speaker.',
|
|
11905
11907
|
enum: ['SET_SPEAKER_VOLUME'],
|
|
11906
11908
|
type: 'string',
|
|
11909
|
+
'x-undocumented': 'Unreleased.',
|
|
11907
11910
|
},
|
|
11908
11911
|
error: {
|
|
11909
11912
|
description:
|
|
@@ -11925,6 +11928,7 @@ const openapi: OpenAPISpec = {
|
|
|
11925
11928
|
'result',
|
|
11926
11929
|
],
|
|
11927
11930
|
type: 'object',
|
|
11931
|
+
'x-undocumented': 'Unreleased.',
|
|
11928
11932
|
},
|
|
11929
11933
|
{
|
|
11930
11934
|
description: 'Setting the speaker volume failed.',
|
|
@@ -11939,6 +11943,7 @@ const openapi: OpenAPISpec = {
|
|
|
11939
11943
|
'Action attempt to track the status of setting the volume on a speaker.',
|
|
11940
11944
|
enum: ['SET_SPEAKER_VOLUME'],
|
|
11941
11945
|
type: 'string',
|
|
11946
|
+
'x-undocumented': 'Unreleased.',
|
|
11942
11947
|
},
|
|
11943
11948
|
error: {
|
|
11944
11949
|
description: 'Error associated with the action.',
|
|
@@ -11968,6 +11973,7 @@ const openapi: OpenAPISpec = {
|
|
|
11968
11973
|
'error',
|
|
11969
11974
|
],
|
|
11970
11975
|
type: 'object',
|
|
11976
|
+
'x-undocumented': 'Unreleased.',
|
|
11971
11977
|
},
|
|
11972
11978
|
{
|
|
11973
11979
|
description: 'Muting or unmuting the speaker is pending.',
|
|
@@ -11982,6 +11988,7 @@ const openapi: OpenAPISpec = {
|
|
|
11982
11988
|
'Action attempt to track the status of muting or unmuting a speaker.',
|
|
11983
11989
|
enum: ['SET_SPEAKER_MUTE'],
|
|
11984
11990
|
type: 'string',
|
|
11991
|
+
'x-undocumented': 'Unreleased.',
|
|
11985
11992
|
},
|
|
11986
11993
|
error: {
|
|
11987
11994
|
description:
|
|
@@ -12003,6 +12010,7 @@ const openapi: OpenAPISpec = {
|
|
|
12003
12010
|
'action_type',
|
|
12004
12011
|
],
|
|
12005
12012
|
type: 'object',
|
|
12013
|
+
'x-undocumented': 'Unreleased.',
|
|
12006
12014
|
},
|
|
12007
12015
|
{
|
|
12008
12016
|
description: 'Muting or unmuting the speaker succeeded.',
|
|
@@ -12017,6 +12025,7 @@ const openapi: OpenAPISpec = {
|
|
|
12017
12025
|
'Action attempt to track the status of muting or unmuting a speaker.',
|
|
12018
12026
|
enum: ['SET_SPEAKER_MUTE'],
|
|
12019
12027
|
type: 'string',
|
|
12028
|
+
'x-undocumented': 'Unreleased.',
|
|
12020
12029
|
},
|
|
12021
12030
|
error: {
|
|
12022
12031
|
description:
|
|
@@ -12038,6 +12047,7 @@ const openapi: OpenAPISpec = {
|
|
|
12038
12047
|
'result',
|
|
12039
12048
|
],
|
|
12040
12049
|
type: 'object',
|
|
12050
|
+
'x-undocumented': 'Unreleased.',
|
|
12041
12051
|
},
|
|
12042
12052
|
{
|
|
12043
12053
|
description: 'Muting or unmuting the speaker failed.',
|
|
@@ -12052,6 +12062,7 @@ const openapi: OpenAPISpec = {
|
|
|
12052
12062
|
'Action attempt to track the status of muting or unmuting a speaker.',
|
|
12053
12063
|
enum: ['SET_SPEAKER_MUTE'],
|
|
12054
12064
|
type: 'string',
|
|
12065
|
+
'x-undocumented': 'Unreleased.',
|
|
12055
12066
|
},
|
|
12056
12067
|
error: {
|
|
12057
12068
|
description: 'Error associated with the action.',
|
|
@@ -12081,6 +12092,7 @@ const openapi: OpenAPISpec = {
|
|
|
12081
12092
|
'error',
|
|
12082
12093
|
],
|
|
12083
12094
|
type: 'object',
|
|
12095
|
+
'x-undocumented': 'Unreleased.',
|
|
12084
12096
|
},
|
|
12085
12097
|
{
|
|
12086
12098
|
description: 'Pausing playback on the speaker is pending.',
|
|
@@ -12095,6 +12107,7 @@ const openapi: OpenAPISpec = {
|
|
|
12095
12107
|
'Action attempt to track the status of pausing playback on a speaker.',
|
|
12096
12108
|
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
12097
12109
|
type: 'string',
|
|
12110
|
+
'x-undocumented': 'Unreleased.',
|
|
12098
12111
|
},
|
|
12099
12112
|
error: {
|
|
12100
12113
|
description:
|
|
@@ -12116,6 +12129,7 @@ const openapi: OpenAPISpec = {
|
|
|
12116
12129
|
'action_type',
|
|
12117
12130
|
],
|
|
12118
12131
|
type: 'object',
|
|
12132
|
+
'x-undocumented': 'Unreleased.',
|
|
12119
12133
|
},
|
|
12120
12134
|
{
|
|
12121
12135
|
description: 'Pausing playback on the speaker succeeded.',
|
|
@@ -12130,6 +12144,7 @@ const openapi: OpenAPISpec = {
|
|
|
12130
12144
|
'Action attempt to track the status of pausing playback on a speaker.',
|
|
12131
12145
|
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
12132
12146
|
type: 'string',
|
|
12147
|
+
'x-undocumented': 'Unreleased.',
|
|
12133
12148
|
},
|
|
12134
12149
|
error: {
|
|
12135
12150
|
description:
|
|
@@ -12159,6 +12174,7 @@ const openapi: OpenAPISpec = {
|
|
|
12159
12174
|
'result',
|
|
12160
12175
|
],
|
|
12161
12176
|
type: 'object',
|
|
12177
|
+
'x-undocumented': 'Unreleased.',
|
|
12162
12178
|
},
|
|
12163
12179
|
{
|
|
12164
12180
|
description: 'Pausing playback on the speaker failed.',
|
|
@@ -12173,6 +12189,7 @@ const openapi: OpenAPISpec = {
|
|
|
12173
12189
|
'Action attempt to track the status of pausing playback on a speaker.',
|
|
12174
12190
|
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
12175
12191
|
type: 'string',
|
|
12192
|
+
'x-undocumented': 'Unreleased.',
|
|
12176
12193
|
},
|
|
12177
12194
|
error: {
|
|
12178
12195
|
description: 'Error associated with the action.',
|
|
@@ -12202,6 +12219,7 @@ const openapi: OpenAPISpec = {
|
|
|
12202
12219
|
'error',
|
|
12203
12220
|
],
|
|
12204
12221
|
type: 'object',
|
|
12222
|
+
'x-undocumented': 'Unreleased.',
|
|
12205
12223
|
},
|
|
12206
12224
|
{
|
|
12207
12225
|
description: 'Resuming playback on the speaker is pending.',
|
|
@@ -12216,6 +12234,7 @@ const openapi: OpenAPISpec = {
|
|
|
12216
12234
|
'Action attempt to track the status of resuming playback on a speaker.',
|
|
12217
12235
|
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
12218
12236
|
type: 'string',
|
|
12237
|
+
'x-undocumented': 'Unreleased.',
|
|
12219
12238
|
},
|
|
12220
12239
|
error: {
|
|
12221
12240
|
description:
|
|
@@ -12237,6 +12256,7 @@ const openapi: OpenAPISpec = {
|
|
|
12237
12256
|
'action_type',
|
|
12238
12257
|
],
|
|
12239
12258
|
type: 'object',
|
|
12259
|
+
'x-undocumented': 'Unreleased.',
|
|
12240
12260
|
},
|
|
12241
12261
|
{
|
|
12242
12262
|
description: 'Resuming playback on the speaker succeeded.',
|
|
@@ -12251,6 +12271,7 @@ const openapi: OpenAPISpec = {
|
|
|
12251
12271
|
'Action attempt to track the status of resuming playback on a speaker.',
|
|
12252
12272
|
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
12253
12273
|
type: 'string',
|
|
12274
|
+
'x-undocumented': 'Unreleased.',
|
|
12254
12275
|
},
|
|
12255
12276
|
error: {
|
|
12256
12277
|
description:
|
|
@@ -12280,6 +12301,7 @@ const openapi: OpenAPISpec = {
|
|
|
12280
12301
|
'result',
|
|
12281
12302
|
],
|
|
12282
12303
|
type: 'object',
|
|
12304
|
+
'x-undocumented': 'Unreleased.',
|
|
12283
12305
|
},
|
|
12284
12306
|
{
|
|
12285
12307
|
description: 'Resuming playback on the speaker failed.',
|
|
@@ -12294,6 +12316,7 @@ const openapi: OpenAPISpec = {
|
|
|
12294
12316
|
'Action attempt to track the status of resuming playback on a speaker.',
|
|
12295
12317
|
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
12296
12318
|
type: 'string',
|
|
12319
|
+
'x-undocumented': 'Unreleased.',
|
|
12297
12320
|
},
|
|
12298
12321
|
error: {
|
|
12299
12322
|
description: 'Error associated with the action.',
|
|
@@ -12323,6 +12346,7 @@ const openapi: OpenAPISpec = {
|
|
|
12323
12346
|
'error',
|
|
12324
12347
|
],
|
|
12325
12348
|
type: 'object',
|
|
12349
|
+
'x-undocumented': 'Unreleased.',
|
|
12326
12350
|
},
|
|
12327
12351
|
{
|
|
12328
12352
|
description: 'Playing a chime on the speaker is pending.',
|
|
@@ -12337,6 +12361,7 @@ const openapi: OpenAPISpec = {
|
|
|
12337
12361
|
'Action attempt to track the status of playing a chime on a speaker.',
|
|
12338
12362
|
enum: ['PLAY_SPEAKER_CHIME'],
|
|
12339
12363
|
type: 'string',
|
|
12364
|
+
'x-undocumented': 'Unreleased.',
|
|
12340
12365
|
},
|
|
12341
12366
|
error: {
|
|
12342
12367
|
description:
|
|
@@ -12358,6 +12383,7 @@ const openapi: OpenAPISpec = {
|
|
|
12358
12383
|
'action_type',
|
|
12359
12384
|
],
|
|
12360
12385
|
type: 'object',
|
|
12386
|
+
'x-undocumented': 'Unreleased.',
|
|
12361
12387
|
},
|
|
12362
12388
|
{
|
|
12363
12389
|
description: 'Playing a chime on the speaker succeeded.',
|
|
@@ -12372,6 +12398,7 @@ const openapi: OpenAPISpec = {
|
|
|
12372
12398
|
'Action attempt to track the status of playing a chime on a speaker.',
|
|
12373
12399
|
enum: ['PLAY_SPEAKER_CHIME'],
|
|
12374
12400
|
type: 'string',
|
|
12401
|
+
'x-undocumented': 'Unreleased.',
|
|
12375
12402
|
},
|
|
12376
12403
|
error: {
|
|
12377
12404
|
description:
|
|
@@ -12393,6 +12420,7 @@ const openapi: OpenAPISpec = {
|
|
|
12393
12420
|
'result',
|
|
12394
12421
|
],
|
|
12395
12422
|
type: 'object',
|
|
12423
|
+
'x-undocumented': 'Unreleased.',
|
|
12396
12424
|
},
|
|
12397
12425
|
{
|
|
12398
12426
|
description: 'Playing a chime on the speaker failed.',
|
|
@@ -12407,6 +12435,7 @@ const openapi: OpenAPISpec = {
|
|
|
12407
12435
|
'Action attempt to track the status of playing a chime on a speaker.',
|
|
12408
12436
|
enum: ['PLAY_SPEAKER_CHIME'],
|
|
12409
12437
|
type: 'string',
|
|
12438
|
+
'x-undocumented': 'Unreleased.',
|
|
12410
12439
|
},
|
|
12411
12440
|
error: {
|
|
12412
12441
|
description: 'Error associated with the action.',
|
|
@@ -12436,6 +12465,253 @@ const openapi: OpenAPISpec = {
|
|
|
12436
12465
|
'error',
|
|
12437
12466
|
],
|
|
12438
12467
|
type: 'object',
|
|
12468
|
+
'x-undocumented': 'Unreleased.',
|
|
12469
|
+
},
|
|
12470
|
+
{
|
|
12471
|
+
description: 'Playing a favorite on the speaker is pending.',
|
|
12472
|
+
properties: {
|
|
12473
|
+
action_attempt_id: {
|
|
12474
|
+
description: 'ID of the action attempt.',
|
|
12475
|
+
format: 'uuid',
|
|
12476
|
+
type: 'string',
|
|
12477
|
+
},
|
|
12478
|
+
action_type: {
|
|
12479
|
+
description:
|
|
12480
|
+
'Action attempt to track the status of playing a favorite on a speaker.',
|
|
12481
|
+
enum: ['PLAY_SPEAKER_FAVORITE'],
|
|
12482
|
+
type: 'string',
|
|
12483
|
+
'x-undocumented': 'Unreleased.',
|
|
12484
|
+
},
|
|
12485
|
+
error: {
|
|
12486
|
+
description:
|
|
12487
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
12488
|
+
nullable: true,
|
|
12489
|
+
},
|
|
12490
|
+
result: {
|
|
12491
|
+
description:
|
|
12492
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
12493
|
+
nullable: true,
|
|
12494
|
+
},
|
|
12495
|
+
status: { enum: ['pending'], type: 'string' },
|
|
12496
|
+
},
|
|
12497
|
+
required: [
|
|
12498
|
+
'action_attempt_id',
|
|
12499
|
+
'status',
|
|
12500
|
+
'result',
|
|
12501
|
+
'error',
|
|
12502
|
+
'action_type',
|
|
12503
|
+
],
|
|
12504
|
+
type: 'object',
|
|
12505
|
+
'x-undocumented': 'Unreleased.',
|
|
12506
|
+
},
|
|
12507
|
+
{
|
|
12508
|
+
description: 'Playing a favorite on the speaker succeeded.',
|
|
12509
|
+
properties: {
|
|
12510
|
+
action_attempt_id: {
|
|
12511
|
+
description: 'ID of the action attempt.',
|
|
12512
|
+
format: 'uuid',
|
|
12513
|
+
type: 'string',
|
|
12514
|
+
},
|
|
12515
|
+
action_type: {
|
|
12516
|
+
description:
|
|
12517
|
+
'Action attempt to track the status of playing a favorite on a speaker.',
|
|
12518
|
+
enum: ['PLAY_SPEAKER_FAVORITE'],
|
|
12519
|
+
type: 'string',
|
|
12520
|
+
'x-undocumented': 'Unreleased.',
|
|
12521
|
+
},
|
|
12522
|
+
error: {
|
|
12523
|
+
description:
|
|
12524
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12525
|
+
nullable: true,
|
|
12526
|
+
},
|
|
12527
|
+
result: {
|
|
12528
|
+
description: 'Result of the action.',
|
|
12529
|
+
properties: {
|
|
12530
|
+
affected_device_ids: {
|
|
12531
|
+
description:
|
|
12532
|
+
'IDs of the speakers now playing the favorite, including speakers grouped with the requested speaker.',
|
|
12533
|
+
items: { format: 'uuid', type: 'string' },
|
|
12534
|
+
type: 'array',
|
|
12535
|
+
},
|
|
12536
|
+
},
|
|
12537
|
+
required: ['affected_device_ids'],
|
|
12538
|
+
type: 'object',
|
|
12539
|
+
},
|
|
12540
|
+
status: { enum: ['success'], type: 'string' },
|
|
12541
|
+
},
|
|
12542
|
+
required: [
|
|
12543
|
+
'action_attempt_id',
|
|
12544
|
+
'status',
|
|
12545
|
+
'error',
|
|
12546
|
+
'action_type',
|
|
12547
|
+
'result',
|
|
12548
|
+
],
|
|
12549
|
+
type: 'object',
|
|
12550
|
+
'x-undocumented': 'Unreleased.',
|
|
12551
|
+
},
|
|
12552
|
+
{
|
|
12553
|
+
description: 'Playing a favorite on the speaker failed.',
|
|
12554
|
+
properties: {
|
|
12555
|
+
action_attempt_id: {
|
|
12556
|
+
description: 'ID of the action attempt.',
|
|
12557
|
+
format: 'uuid',
|
|
12558
|
+
type: 'string',
|
|
12559
|
+
},
|
|
12560
|
+
action_type: {
|
|
12561
|
+
description:
|
|
12562
|
+
'Action attempt to track the status of playing a favorite on a speaker.',
|
|
12563
|
+
enum: ['PLAY_SPEAKER_FAVORITE'],
|
|
12564
|
+
type: 'string',
|
|
12565
|
+
'x-undocumented': 'Unreleased.',
|
|
12566
|
+
},
|
|
12567
|
+
error: {
|
|
12568
|
+
description: 'Error associated with the action.',
|
|
12569
|
+
properties: {
|
|
12570
|
+
message: {
|
|
12571
|
+
description:
|
|
12572
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12573
|
+
type: 'string',
|
|
12574
|
+
},
|
|
12575
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
12576
|
+
},
|
|
12577
|
+
required: ['type', 'message'],
|
|
12578
|
+
type: 'object',
|
|
12579
|
+
},
|
|
12580
|
+
result: {
|
|
12581
|
+
description:
|
|
12582
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
12583
|
+
nullable: true,
|
|
12584
|
+
},
|
|
12585
|
+
status: { enum: ['error'], type: 'string' },
|
|
12586
|
+
},
|
|
12587
|
+
required: [
|
|
12588
|
+
'action_attempt_id',
|
|
12589
|
+
'status',
|
|
12590
|
+
'result',
|
|
12591
|
+
'action_type',
|
|
12592
|
+
'error',
|
|
12593
|
+
],
|
|
12594
|
+
type: 'object',
|
|
12595
|
+
'x-undocumented': 'Unreleased.',
|
|
12596
|
+
},
|
|
12597
|
+
{
|
|
12598
|
+
description: 'Playing an audio clip on the speaker is pending.',
|
|
12599
|
+
properties: {
|
|
12600
|
+
action_attempt_id: {
|
|
12601
|
+
description: 'ID of the action attempt.',
|
|
12602
|
+
format: 'uuid',
|
|
12603
|
+
type: 'string',
|
|
12604
|
+
},
|
|
12605
|
+
action_type: {
|
|
12606
|
+
description:
|
|
12607
|
+
'Action attempt to track the status of playing an audio clip on a speaker.',
|
|
12608
|
+
enum: ['PLAY_SPEAKER_AUDIO_CLIP'],
|
|
12609
|
+
type: 'string',
|
|
12610
|
+
'x-undocumented': 'Unreleased.',
|
|
12611
|
+
},
|
|
12612
|
+
error: {
|
|
12613
|
+
description:
|
|
12614
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
12615
|
+
nullable: true,
|
|
12616
|
+
},
|
|
12617
|
+
result: {
|
|
12618
|
+
description:
|
|
12619
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
12620
|
+
nullable: true,
|
|
12621
|
+
},
|
|
12622
|
+
status: { enum: ['pending'], type: 'string' },
|
|
12623
|
+
},
|
|
12624
|
+
required: [
|
|
12625
|
+
'action_attempt_id',
|
|
12626
|
+
'status',
|
|
12627
|
+
'result',
|
|
12628
|
+
'error',
|
|
12629
|
+
'action_type',
|
|
12630
|
+
],
|
|
12631
|
+
type: 'object',
|
|
12632
|
+
'x-undocumented': 'Unreleased.',
|
|
12633
|
+
},
|
|
12634
|
+
{
|
|
12635
|
+
description: 'Playing an audio clip on the speaker succeeded.',
|
|
12636
|
+
properties: {
|
|
12637
|
+
action_attempt_id: {
|
|
12638
|
+
description: 'ID of the action attempt.',
|
|
12639
|
+
format: 'uuid',
|
|
12640
|
+
type: 'string',
|
|
12641
|
+
},
|
|
12642
|
+
action_type: {
|
|
12643
|
+
description:
|
|
12644
|
+
'Action attempt to track the status of playing an audio clip on a speaker.',
|
|
12645
|
+
enum: ['PLAY_SPEAKER_AUDIO_CLIP'],
|
|
12646
|
+
type: 'string',
|
|
12647
|
+
'x-undocumented': 'Unreleased.',
|
|
12648
|
+
},
|
|
12649
|
+
error: {
|
|
12650
|
+
description:
|
|
12651
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12652
|
+
nullable: true,
|
|
12653
|
+
},
|
|
12654
|
+
result: {
|
|
12655
|
+
description: 'Result of the action.',
|
|
12656
|
+
properties: {},
|
|
12657
|
+
type: 'object',
|
|
12658
|
+
},
|
|
12659
|
+
status: { enum: ['success'], type: 'string' },
|
|
12660
|
+
},
|
|
12661
|
+
required: [
|
|
12662
|
+
'action_attempt_id',
|
|
12663
|
+
'status',
|
|
12664
|
+
'error',
|
|
12665
|
+
'action_type',
|
|
12666
|
+
'result',
|
|
12667
|
+
],
|
|
12668
|
+
type: 'object',
|
|
12669
|
+
'x-undocumented': 'Unreleased.',
|
|
12670
|
+
},
|
|
12671
|
+
{
|
|
12672
|
+
description: 'Playing an audio clip on the speaker failed.',
|
|
12673
|
+
properties: {
|
|
12674
|
+
action_attempt_id: {
|
|
12675
|
+
description: 'ID of the action attempt.',
|
|
12676
|
+
format: 'uuid',
|
|
12677
|
+
type: 'string',
|
|
12678
|
+
},
|
|
12679
|
+
action_type: {
|
|
12680
|
+
description:
|
|
12681
|
+
'Action attempt to track the status of playing an audio clip on a speaker.',
|
|
12682
|
+
enum: ['PLAY_SPEAKER_AUDIO_CLIP'],
|
|
12683
|
+
type: 'string',
|
|
12684
|
+
'x-undocumented': 'Unreleased.',
|
|
12685
|
+
},
|
|
12686
|
+
error: {
|
|
12687
|
+
description: 'Error associated with the action.',
|
|
12688
|
+
properties: {
|
|
12689
|
+
message: {
|
|
12690
|
+
description:
|
|
12691
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12692
|
+
type: 'string',
|
|
12693
|
+
},
|
|
12694
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
12695
|
+
},
|
|
12696
|
+
required: ['type', 'message'],
|
|
12697
|
+
type: 'object',
|
|
12698
|
+
},
|
|
12699
|
+
result: {
|
|
12700
|
+
description:
|
|
12701
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
12702
|
+
nullable: true,
|
|
12703
|
+
},
|
|
12704
|
+
status: { enum: ['error'], type: 'string' },
|
|
12705
|
+
},
|
|
12706
|
+
required: [
|
|
12707
|
+
'action_attempt_id',
|
|
12708
|
+
'status',
|
|
12709
|
+
'result',
|
|
12710
|
+
'action_type',
|
|
12711
|
+
'error',
|
|
12712
|
+
],
|
|
12713
|
+
type: 'object',
|
|
12714
|
+
'x-undocumented': 'Unreleased.',
|
|
12439
12715
|
},
|
|
12440
12716
|
{
|
|
12441
12717
|
properties: {
|
|
@@ -14979,16 +15255,31 @@ const openapi: OpenAPISpec = {
|
|
|
14979
15255
|
can_mute_speaker: {
|
|
14980
15256
|
description: 'Indicates whether the speaker supports muting.',
|
|
14981
15257
|
type: 'boolean',
|
|
15258
|
+
'x-undocumented': 'Unreleased.',
|
|
14982
15259
|
},
|
|
14983
15260
|
can_pause_speaker_playback: {
|
|
14984
15261
|
description:
|
|
14985
15262
|
'Indicates whether the speaker supports pausing playback.',
|
|
14986
15263
|
type: 'boolean',
|
|
15264
|
+
'x-undocumented': 'Unreleased.',
|
|
15265
|
+
},
|
|
15266
|
+
can_play_speaker_audio_clip: {
|
|
15267
|
+
description:
|
|
15268
|
+
'Indicates whether the speaker supports playing an audio clip from a URL.',
|
|
15269
|
+
type: 'boolean',
|
|
15270
|
+
'x-undocumented': 'Unreleased.',
|
|
14987
15271
|
},
|
|
14988
15272
|
can_play_speaker_chime: {
|
|
14989
15273
|
description:
|
|
14990
15274
|
'Indicates whether the speaker supports playing a chime.',
|
|
14991
15275
|
type: 'boolean',
|
|
15276
|
+
'x-undocumented': 'Unreleased.',
|
|
15277
|
+
},
|
|
15278
|
+
can_play_speaker_favorite: {
|
|
15279
|
+
description:
|
|
15280
|
+
"Indicates whether the speaker supports listing and playing the favorites saved in the speaker manufacturer's app, such as playlists and radio stations.",
|
|
15281
|
+
type: 'boolean',
|
|
15282
|
+
'x-undocumented': 'Unreleased.',
|
|
14992
15283
|
},
|
|
14993
15284
|
can_program_offline_access_codes: {
|
|
14994
15285
|
description:
|
|
@@ -15029,6 +15320,7 @@ const openapi: OpenAPISpec = {
|
|
|
15029
15320
|
description:
|
|
15030
15321
|
'Indicates whether the speaker supports resuming playback.',
|
|
15031
15322
|
type: 'boolean',
|
|
15323
|
+
'x-undocumented': 'Unreleased.',
|
|
15032
15324
|
},
|
|
15033
15325
|
can_run_thermostat_programs: {
|
|
15034
15326
|
description:
|
|
@@ -15039,6 +15331,7 @@ const openapi: OpenAPISpec = {
|
|
|
15039
15331
|
description:
|
|
15040
15332
|
'Indicates whether the speaker supports setting its volume.',
|
|
15041
15333
|
type: 'boolean',
|
|
15334
|
+
'x-undocumented': 'Unreleased.',
|
|
15042
15335
|
},
|
|
15043
15336
|
can_simulate_connection: {
|
|
15044
15337
|
description:
|
|
@@ -15087,6 +15380,7 @@ const openapi: OpenAPISpec = {
|
|
|
15087
15380
|
can_unmute_speaker: {
|
|
15088
15381
|
description: 'Indicates whether the speaker supports unmuting.',
|
|
15089
15382
|
type: 'boolean',
|
|
15383
|
+
'x-undocumented': 'Unreleased.',
|
|
15090
15384
|
},
|
|
15091
15385
|
capabilities_supported: {
|
|
15092
15386
|
description:
|
|
@@ -17351,6 +17645,7 @@ const openapi: OpenAPISpec = {
|
|
|
17351
17645
|
},
|
|
17352
17646
|
},
|
|
17353
17647
|
type: 'object',
|
|
17648
|
+
'x-undocumented': 'Unreleased.',
|
|
17354
17649
|
},
|
|
17355
17650
|
tado_metadata: {
|
|
17356
17651
|
description: 'Metadata for a tado° device.',
|
|
@@ -17987,7 +18282,7 @@ const openapi: OpenAPISpec = {
|
|
|
17987
18282
|
},
|
|
17988
18283
|
supports_chime: {
|
|
17989
18284
|
description:
|
|
17990
|
-
'Indicates whether the speaker can play a chime.',
|
|
18285
|
+
'Indicates whether the speaker can play a chime or an audio clip.',
|
|
17991
18286
|
type: 'boolean',
|
|
17992
18287
|
},
|
|
17993
18288
|
volume: {
|
|
@@ -18022,6 +18317,7 @@ const openapi: OpenAPISpec = {
|
|
|
18022
18317
|
],
|
|
18023
18318
|
type: 'object',
|
|
18024
18319
|
'x-property-group-key': 'speakers',
|
|
18320
|
+
'x-undocumented': 'Unreleased.',
|
|
18025
18321
|
},
|
|
18026
18322
|
supported_code_lengths: {
|
|
18027
18323
|
description: 'Supported code lengths for access codes.',
|
|
@@ -19769,16 +20065,31 @@ const openapi: OpenAPISpec = {
|
|
|
19769
20065
|
can_mute_speaker: {
|
|
19770
20066
|
description: 'Indicates whether the speaker supports muting.',
|
|
19771
20067
|
type: 'boolean',
|
|
20068
|
+
'x-undocumented': 'Unreleased.',
|
|
19772
20069
|
},
|
|
19773
20070
|
can_pause_speaker_playback: {
|
|
19774
20071
|
description:
|
|
19775
20072
|
'Indicates whether the speaker supports pausing playback.',
|
|
19776
20073
|
type: 'boolean',
|
|
20074
|
+
'x-undocumented': 'Unreleased.',
|
|
20075
|
+
},
|
|
20076
|
+
can_play_speaker_audio_clip: {
|
|
20077
|
+
description:
|
|
20078
|
+
'Indicates whether the speaker supports playing an audio clip from a URL.',
|
|
20079
|
+
type: 'boolean',
|
|
20080
|
+
'x-undocumented': 'Unreleased.',
|
|
19777
20081
|
},
|
|
19778
20082
|
can_play_speaker_chime: {
|
|
19779
20083
|
description:
|
|
19780
20084
|
'Indicates whether the speaker supports playing a chime.',
|
|
19781
20085
|
type: 'boolean',
|
|
20086
|
+
'x-undocumented': 'Unreleased.',
|
|
20087
|
+
},
|
|
20088
|
+
can_play_speaker_favorite: {
|
|
20089
|
+
description:
|
|
20090
|
+
"Indicates whether the speaker supports listing and playing the favorites saved in the speaker manufacturer's app, such as playlists and radio stations.",
|
|
20091
|
+
type: 'boolean',
|
|
20092
|
+
'x-undocumented': 'Unreleased.',
|
|
19782
20093
|
},
|
|
19783
20094
|
can_program_offline_access_codes: {
|
|
19784
20095
|
description:
|
|
@@ -19819,6 +20130,7 @@ const openapi: OpenAPISpec = {
|
|
|
19819
20130
|
description:
|
|
19820
20131
|
'Indicates whether the speaker supports resuming playback.',
|
|
19821
20132
|
type: 'boolean',
|
|
20133
|
+
'x-undocumented': 'Unreleased.',
|
|
19822
20134
|
},
|
|
19823
20135
|
can_run_thermostat_programs: {
|
|
19824
20136
|
description:
|
|
@@ -19829,6 +20141,7 @@ const openapi: OpenAPISpec = {
|
|
|
19829
20141
|
description:
|
|
19830
20142
|
'Indicates whether the speaker supports setting its volume.',
|
|
19831
20143
|
type: 'boolean',
|
|
20144
|
+
'x-undocumented': 'Unreleased.',
|
|
19832
20145
|
},
|
|
19833
20146
|
can_simulate_connection: {
|
|
19834
20147
|
description:
|
|
@@ -19877,6 +20190,7 @@ const openapi: OpenAPISpec = {
|
|
|
19877
20190
|
can_unmute_speaker: {
|
|
19878
20191
|
description: 'Indicates whether the speaker supports unmuting.',
|
|
19879
20192
|
type: 'boolean',
|
|
20193
|
+
'x-undocumented': 'Unreleased.',
|
|
19880
20194
|
},
|
|
19881
20195
|
device_provider_name: {
|
|
19882
20196
|
description: 'Name of the device provider.',
|
|
@@ -39720,16 +40034,31 @@ const openapi: OpenAPISpec = {
|
|
|
39720
40034
|
can_mute_speaker: {
|
|
39721
40035
|
description: 'Indicates whether the speaker supports muting.',
|
|
39722
40036
|
type: 'boolean',
|
|
40037
|
+
'x-undocumented': 'Unreleased.',
|
|
39723
40038
|
},
|
|
39724
40039
|
can_pause_speaker_playback: {
|
|
39725
40040
|
description:
|
|
39726
40041
|
'Indicates whether the speaker supports pausing playback.',
|
|
39727
40042
|
type: 'boolean',
|
|
40043
|
+
'x-undocumented': 'Unreleased.',
|
|
40044
|
+
},
|
|
40045
|
+
can_play_speaker_audio_clip: {
|
|
40046
|
+
description:
|
|
40047
|
+
'Indicates whether the speaker supports playing an audio clip from a URL.',
|
|
40048
|
+
type: 'boolean',
|
|
40049
|
+
'x-undocumented': 'Unreleased.',
|
|
39728
40050
|
},
|
|
39729
40051
|
can_play_speaker_chime: {
|
|
39730
40052
|
description:
|
|
39731
40053
|
'Indicates whether the speaker supports playing a chime.',
|
|
39732
40054
|
type: 'boolean',
|
|
40055
|
+
'x-undocumented': 'Unreleased.',
|
|
40056
|
+
},
|
|
40057
|
+
can_play_speaker_favorite: {
|
|
40058
|
+
description:
|
|
40059
|
+
"Indicates whether the speaker supports listing and playing the favorites saved in the speaker manufacturer's app, such as playlists and radio stations.",
|
|
40060
|
+
type: 'boolean',
|
|
40061
|
+
'x-undocumented': 'Unreleased.',
|
|
39733
40062
|
},
|
|
39734
40063
|
can_program_offline_access_codes: {
|
|
39735
40064
|
description:
|
|
@@ -39770,6 +40099,7 @@ const openapi: OpenAPISpec = {
|
|
|
39770
40099
|
description:
|
|
39771
40100
|
'Indicates whether the speaker supports resuming playback.',
|
|
39772
40101
|
type: 'boolean',
|
|
40102
|
+
'x-undocumented': 'Unreleased.',
|
|
39773
40103
|
},
|
|
39774
40104
|
can_run_thermostat_programs: {
|
|
39775
40105
|
description:
|
|
@@ -39780,6 +40110,7 @@ const openapi: OpenAPISpec = {
|
|
|
39780
40110
|
description:
|
|
39781
40111
|
'Indicates whether the speaker supports setting its volume.',
|
|
39782
40112
|
type: 'boolean',
|
|
40113
|
+
'x-undocumented': 'Unreleased.',
|
|
39783
40114
|
},
|
|
39784
40115
|
can_simulate_connection: {
|
|
39785
40116
|
description:
|
|
@@ -39828,6 +40159,7 @@ const openapi: OpenAPISpec = {
|
|
|
39828
40159
|
can_unmute_speaker: {
|
|
39829
40160
|
description: 'Indicates whether the speaker supports unmuting.',
|
|
39830
40161
|
type: 'boolean',
|
|
40162
|
+
'x-undocumented': 'Unreleased.',
|
|
39831
40163
|
},
|
|
39832
40164
|
capabilities_supported: {
|
|
39833
40165
|
description:
|
|
@@ -54797,6 +55129,8 @@ const openapi: OpenAPISpec = {
|
|
|
54797
55129
|
'can_pause_speaker_playback',
|
|
54798
55130
|
'can_resume_speaker_playback',
|
|
54799
55131
|
'can_play_speaker_chime',
|
|
55132
|
+
'can_play_speaker_favorite',
|
|
55133
|
+
'can_play_speaker_audio_clip',
|
|
54800
55134
|
],
|
|
54801
55135
|
type: 'string',
|
|
54802
55136
|
},
|
|
@@ -54838,6 +55172,8 @@ const openapi: OpenAPISpec = {
|
|
|
54838
55172
|
'can_pause_speaker_playback',
|
|
54839
55173
|
'can_resume_speaker_playback',
|
|
54840
55174
|
'can_play_speaker_chime',
|
|
55175
|
+
'can_play_speaker_favorite',
|
|
55176
|
+
'can_play_speaker_audio_clip',
|
|
54841
55177
|
],
|
|
54842
55178
|
type: 'string',
|
|
54843
55179
|
},
|
|
@@ -57104,6 +57440,8 @@ const openapi: OpenAPISpec = {
|
|
|
57104
57440
|
'can_pause_speaker_playback',
|
|
57105
57441
|
'can_resume_speaker_playback',
|
|
57106
57442
|
'can_play_speaker_chime',
|
|
57443
|
+
'can_play_speaker_favorite',
|
|
57444
|
+
'can_play_speaker_audio_clip',
|
|
57107
57445
|
],
|
|
57108
57446
|
type: 'string',
|
|
57109
57447
|
},
|
|
@@ -57145,6 +57483,8 @@ const openapi: OpenAPISpec = {
|
|
|
57145
57483
|
'can_pause_speaker_playback',
|
|
57146
57484
|
'can_resume_speaker_playback',
|
|
57147
57485
|
'can_play_speaker_chime',
|
|
57486
|
+
'can_play_speaker_favorite',
|
|
57487
|
+
'can_play_speaker_audio_clip',
|
|
57148
57488
|
],
|
|
57149
57489
|
type: 'string',
|
|
57150
57490
|
},
|
|
@@ -63454,7 +63794,37 @@ const openapi: OpenAPISpec = {
|
|
|
63454
63794
|
},
|
|
63455
63795
|
speakers: {
|
|
63456
63796
|
properties: {
|
|
63797
|
+
play_audio_clip: {
|
|
63798
|
+
properties: {
|
|
63799
|
+
audio_url: {
|
|
63800
|
+
description:
|
|
63801
|
+
'Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself.',
|
|
63802
|
+
format: 'uri',
|
|
63803
|
+
maxLength: 2048,
|
|
63804
|
+
pattern: '^https:\\/\\/',
|
|
63805
|
+
type: 'string',
|
|
63806
|
+
},
|
|
63807
|
+
volume: {
|
|
63808
|
+
maximum: 100,
|
|
63809
|
+
minimum: 0,
|
|
63810
|
+
type: 'integer',
|
|
63811
|
+
},
|
|
63812
|
+
},
|
|
63813
|
+
required: ['audio_url'],
|
|
63814
|
+
type: 'object',
|
|
63815
|
+
},
|
|
63457
63816
|
play_chime: { type: 'boolean' },
|
|
63817
|
+
play_favorite: {
|
|
63818
|
+
properties: {
|
|
63819
|
+
favorite_id: {
|
|
63820
|
+
minLength: 1,
|
|
63821
|
+
type: 'string',
|
|
63822
|
+
},
|
|
63823
|
+
shuffle: { type: 'boolean' },
|
|
63824
|
+
},
|
|
63825
|
+
required: ['favorite_id'],
|
|
63826
|
+
type: 'object',
|
|
63827
|
+
},
|
|
63458
63828
|
set_volume_to: {
|
|
63459
63829
|
maximum: 100,
|
|
63460
63830
|
minimum: 0,
|
|
@@ -63960,7 +64330,37 @@ const openapi: OpenAPISpec = {
|
|
|
63960
64330
|
},
|
|
63961
64331
|
speakers: {
|
|
63962
64332
|
properties: {
|
|
64333
|
+
play_audio_clip: {
|
|
64334
|
+
properties: {
|
|
64335
|
+
audio_url: {
|
|
64336
|
+
description:
|
|
64337
|
+
'Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself.',
|
|
64338
|
+
format: 'uri',
|
|
64339
|
+
maxLength: 2048,
|
|
64340
|
+
pattern: '^https:\\/\\/',
|
|
64341
|
+
type: 'string',
|
|
64342
|
+
},
|
|
64343
|
+
volume: {
|
|
64344
|
+
maximum: 100,
|
|
64345
|
+
minimum: 0,
|
|
64346
|
+
type: 'integer',
|
|
64347
|
+
},
|
|
64348
|
+
},
|
|
64349
|
+
required: ['audio_url'],
|
|
64350
|
+
type: 'object',
|
|
64351
|
+
},
|
|
63963
64352
|
play_chime: { type: 'boolean' },
|
|
64353
|
+
play_favorite: {
|
|
64354
|
+
properties: {
|
|
64355
|
+
favorite_id: {
|
|
64356
|
+
minLength: 1,
|
|
64357
|
+
type: 'string',
|
|
64358
|
+
},
|
|
64359
|
+
shuffle: { type: 'boolean' },
|
|
64360
|
+
},
|
|
64361
|
+
required: ['favorite_id'],
|
|
64362
|
+
type: 'object',
|
|
64363
|
+
},
|
|
63964
64364
|
set_volume_to: {
|
|
63965
64365
|
maximum: 100,
|
|
63966
64366
|
minimum: 0,
|
|
@@ -65399,7 +65799,37 @@ const openapi: OpenAPISpec = {
|
|
|
65399
65799
|
},
|
|
65400
65800
|
speakers: {
|
|
65401
65801
|
properties: {
|
|
65802
|
+
play_audio_clip: {
|
|
65803
|
+
properties: {
|
|
65804
|
+
audio_url: {
|
|
65805
|
+
description:
|
|
65806
|
+
'Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself.',
|
|
65807
|
+
format: 'uri',
|
|
65808
|
+
maxLength: 2048,
|
|
65809
|
+
pattern: '^https:\\/\\/',
|
|
65810
|
+
type: 'string',
|
|
65811
|
+
},
|
|
65812
|
+
volume: {
|
|
65813
|
+
maximum: 100,
|
|
65814
|
+
minimum: 0,
|
|
65815
|
+
type: 'integer',
|
|
65816
|
+
},
|
|
65817
|
+
},
|
|
65818
|
+
required: ['audio_url'],
|
|
65819
|
+
type: 'object',
|
|
65820
|
+
},
|
|
65402
65821
|
play_chime: { type: 'boolean' },
|
|
65822
|
+
play_favorite: {
|
|
65823
|
+
properties: {
|
|
65824
|
+
favorite_id: {
|
|
65825
|
+
minLength: 1,
|
|
65826
|
+
type: 'string',
|
|
65827
|
+
},
|
|
65828
|
+
shuffle: { type: 'boolean' },
|
|
65829
|
+
},
|
|
65830
|
+
required: ['favorite_id'],
|
|
65831
|
+
type: 'object',
|
|
65832
|
+
},
|
|
65403
65833
|
set_volume_to: {
|
|
65404
65834
|
maximum: 100,
|
|
65405
65835
|
minimum: 0,
|
|
@@ -65825,7 +66255,37 @@ const openapi: OpenAPISpec = {
|
|
|
65825
66255
|
},
|
|
65826
66256
|
speakers: {
|
|
65827
66257
|
properties: {
|
|
66258
|
+
play_audio_clip: {
|
|
66259
|
+
properties: {
|
|
66260
|
+
audio_url: {
|
|
66261
|
+
description:
|
|
66262
|
+
'Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself.',
|
|
66263
|
+
format: 'uri',
|
|
66264
|
+
maxLength: 2048,
|
|
66265
|
+
pattern: '^https:\\/\\/',
|
|
66266
|
+
type: 'string',
|
|
66267
|
+
},
|
|
66268
|
+
volume: {
|
|
66269
|
+
maximum: 100,
|
|
66270
|
+
minimum: 0,
|
|
66271
|
+
type: 'integer',
|
|
66272
|
+
},
|
|
66273
|
+
},
|
|
66274
|
+
required: ['audio_url'],
|
|
66275
|
+
type: 'object',
|
|
66276
|
+
},
|
|
65828
66277
|
play_chime: { type: 'boolean' },
|
|
66278
|
+
play_favorite: {
|
|
66279
|
+
properties: {
|
|
66280
|
+
favorite_id: {
|
|
66281
|
+
minLength: 1,
|
|
66282
|
+
type: 'string',
|
|
66283
|
+
},
|
|
66284
|
+
shuffle: { type: 'boolean' },
|
|
66285
|
+
},
|
|
66286
|
+
required: ['favorite_id'],
|
|
66287
|
+
type: 'object',
|
|
66288
|
+
},
|
|
65829
66289
|
set_volume_to: {
|
|
65830
66290
|
maximum: 100,
|
|
65831
66291
|
minimum: 0,
|
|
@@ -71445,6 +71905,90 @@ const openapi: OpenAPISpec = {
|
|
|
71445
71905
|
'x-title': 'Update a Space',
|
|
71446
71906
|
},
|
|
71447
71907
|
},
|
|
71908
|
+
'/speakers/list_favorites': {
|
|
71909
|
+
get: {
|
|
71910
|
+
description:
|
|
71911
|
+
"Returns the favorites saved on a speaker's account in the speaker manufacturer's app, such as playlists, albums and radio stations. To play one, pass its `favorite_id` to `/speakers/play_favorite`. To check whether a speaker supports favorites, use `device.can_play_speaker_favorite`.",
|
|
71912
|
+
operationId: 'speakersListFavoritesGet',
|
|
71913
|
+
parameters: [
|
|
71914
|
+
{
|
|
71915
|
+
in: 'query',
|
|
71916
|
+
name: 'device_id',
|
|
71917
|
+
required: true,
|
|
71918
|
+
schema: {
|
|
71919
|
+
description:
|
|
71920
|
+
'ID of the speaker for which you want to list favorites.',
|
|
71921
|
+
format: 'uuid',
|
|
71922
|
+
type: 'string',
|
|
71923
|
+
},
|
|
71924
|
+
},
|
|
71925
|
+
],
|
|
71926
|
+
responses: {
|
|
71927
|
+
'200': {
|
|
71928
|
+
content: {
|
|
71929
|
+
'application/json': {
|
|
71930
|
+
schema: {
|
|
71931
|
+
properties: {
|
|
71932
|
+
ok: { type: 'boolean' },
|
|
71933
|
+
speaker_favorites: {
|
|
71934
|
+
items: {
|
|
71935
|
+
properties: {
|
|
71936
|
+
description: {
|
|
71937
|
+
description:
|
|
71938
|
+
'Description of the favorite, such as its artist or station.',
|
|
71939
|
+
type: 'string',
|
|
71940
|
+
},
|
|
71941
|
+
favorite_id: {
|
|
71942
|
+
description:
|
|
71943
|
+
'ID of the favorite. Pass it to `/speakers/play_favorite`.',
|
|
71944
|
+
type: 'string',
|
|
71945
|
+
},
|
|
71946
|
+
image_url: {
|
|
71947
|
+
description: "URL of the favorite's artwork.",
|
|
71948
|
+
type: 'string',
|
|
71949
|
+
},
|
|
71950
|
+
name: {
|
|
71951
|
+
description: 'Name of the favorite.',
|
|
71952
|
+
type: 'string',
|
|
71953
|
+
},
|
|
71954
|
+
service_name: {
|
|
71955
|
+
description:
|
|
71956
|
+
'Name of the music service that provides the favorite.',
|
|
71957
|
+
type: 'string',
|
|
71958
|
+
},
|
|
71959
|
+
},
|
|
71960
|
+
required: ['favorite_id', 'name'],
|
|
71961
|
+
type: 'object',
|
|
71962
|
+
},
|
|
71963
|
+
type: 'array',
|
|
71964
|
+
},
|
|
71965
|
+
},
|
|
71966
|
+
required: ['speaker_favorites', 'ok'],
|
|
71967
|
+
type: 'object',
|
|
71968
|
+
},
|
|
71969
|
+
},
|
|
71970
|
+
},
|
|
71971
|
+
description: 'OK',
|
|
71972
|
+
},
|
|
71973
|
+
'400': { description: 'Bad Request' },
|
|
71974
|
+
'401': { description: 'Unauthorized' },
|
|
71975
|
+
},
|
|
71976
|
+
security: [
|
|
71977
|
+
{ client_session: [] },
|
|
71978
|
+
{ pat_with_workspace: [] },
|
|
71979
|
+
{ console_session_with_workspace: [] },
|
|
71980
|
+
{ api_key: [] },
|
|
71981
|
+
],
|
|
71982
|
+
summary: '/speakers/list_favorites',
|
|
71983
|
+
tags: [],
|
|
71984
|
+
'x-fern-sdk-group-name': ['speakers'],
|
|
71985
|
+
'x-fern-sdk-method-name': 'list_favorites',
|
|
71986
|
+
'x-fern-sdk-return-value': 'speaker_favorites',
|
|
71987
|
+
'x-response-key': 'speaker_favorites',
|
|
71988
|
+
'x-title': 'List Speaker Favorites',
|
|
71989
|
+
'x-undocumented': 'Unreleased.',
|
|
71990
|
+
},
|
|
71991
|
+
},
|
|
71448
71992
|
'/speakers/mute': {
|
|
71449
71993
|
post: {
|
|
71450
71994
|
description:
|
|
@@ -71566,6 +72110,80 @@ const openapi: OpenAPISpec = {
|
|
|
71566
72110
|
'x-undocumented': 'Unreleased.',
|
|
71567
72111
|
},
|
|
71568
72112
|
},
|
|
72113
|
+
'/speakers/play_audio_clip': {
|
|
72114
|
+
post: {
|
|
72115
|
+
description:
|
|
72116
|
+
'Plays a short audio clip from a URL on a speaker, over whatever the speaker is playing. Use it for a welcome message or announcement. To check whether a speaker supports audio clips, use `device.can_play_speaker_audio_clip`.',
|
|
72117
|
+
operationId: 'speakersPlayAudioClipPost',
|
|
72118
|
+
requestBody: {
|
|
72119
|
+
content: {
|
|
72120
|
+
'application/json': {
|
|
72121
|
+
schema: {
|
|
72122
|
+
properties: {
|
|
72123
|
+
audio_url: {
|
|
72124
|
+
description:
|
|
72125
|
+
'Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself, so it must be reachable from the internet.',
|
|
72126
|
+
format: 'uri',
|
|
72127
|
+
maxLength: 2048,
|
|
72128
|
+
type: 'string',
|
|
72129
|
+
},
|
|
72130
|
+
device_id: {
|
|
72131
|
+
description:
|
|
72132
|
+
'ID of the speaker on which you want to play the audio clip.',
|
|
72133
|
+
format: 'uuid',
|
|
72134
|
+
type: 'string',
|
|
72135
|
+
},
|
|
72136
|
+
volume: {
|
|
72137
|
+
description:
|
|
72138
|
+
"Volume at which to play the clip, on the speaker's native volume scale. If you omit this parameter, the clip plays at the speaker's current volume.",
|
|
72139
|
+
format: 'float',
|
|
72140
|
+
type: 'number',
|
|
72141
|
+
},
|
|
72142
|
+
},
|
|
72143
|
+
required: ['device_id', 'audio_url'],
|
|
72144
|
+
type: 'object',
|
|
72145
|
+
},
|
|
72146
|
+
},
|
|
72147
|
+
},
|
|
72148
|
+
},
|
|
72149
|
+
responses: {
|
|
72150
|
+
'200': {
|
|
72151
|
+
content: {
|
|
72152
|
+
'application/json': {
|
|
72153
|
+
schema: {
|
|
72154
|
+
properties: {
|
|
72155
|
+
action_attempt: {
|
|
72156
|
+
$ref: '#/components/schemas/action_attempt',
|
|
72157
|
+
},
|
|
72158
|
+
ok: { type: 'boolean' },
|
|
72159
|
+
},
|
|
72160
|
+
required: ['action_attempt', 'ok'],
|
|
72161
|
+
type: 'object',
|
|
72162
|
+
},
|
|
72163
|
+
},
|
|
72164
|
+
},
|
|
72165
|
+
description: 'OK',
|
|
72166
|
+
},
|
|
72167
|
+
'400': { description: 'Bad Request' },
|
|
72168
|
+
'401': { description: 'Unauthorized' },
|
|
72169
|
+
},
|
|
72170
|
+
security: [
|
|
72171
|
+
{ client_session: [] },
|
|
72172
|
+
{ pat_with_workspace: [] },
|
|
72173
|
+
{ console_session_with_workspace: [] },
|
|
72174
|
+
{ api_key: [] },
|
|
72175
|
+
],
|
|
72176
|
+
summary: '/speakers/play_audio_clip',
|
|
72177
|
+
tags: [],
|
|
72178
|
+
'x-action-attempt-type': 'PLAY_SPEAKER_AUDIO_CLIP',
|
|
72179
|
+
'x-fern-sdk-group-name': ['speakers'],
|
|
72180
|
+
'x-fern-sdk-method-name': 'play_audio_clip',
|
|
72181
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
72182
|
+
'x-response-key': 'action_attempt',
|
|
72183
|
+
'x-title': 'Play an Audio Clip on a Speaker',
|
|
72184
|
+
'x-undocumented': 'Unreleased.',
|
|
72185
|
+
},
|
|
72186
|
+
},
|
|
71569
72187
|
'/speakers/play_chime': {
|
|
71570
72188
|
post: {
|
|
71571
72189
|
description:
|
|
@@ -71633,6 +72251,78 @@ const openapi: OpenAPISpec = {
|
|
|
71633
72251
|
'x-undocumented': 'Unreleased.',
|
|
71634
72252
|
},
|
|
71635
72253
|
},
|
|
72254
|
+
'/speakers/play_favorite': {
|
|
72255
|
+
post: {
|
|
72256
|
+
description:
|
|
72257
|
+
'Replaces what a speaker is playing with one of its favorites and starts playback. Speakers grouped with the requested speaker play it too. To check whether a speaker supports favorites, use `device.can_play_speaker_favorite`.',
|
|
72258
|
+
operationId: 'speakersPlayFavoritePost',
|
|
72259
|
+
requestBody: {
|
|
72260
|
+
content: {
|
|
72261
|
+
'application/json': {
|
|
72262
|
+
schema: {
|
|
72263
|
+
properties: {
|
|
72264
|
+
device_id: {
|
|
72265
|
+
description:
|
|
72266
|
+
'ID of the speaker on which you want to play the favorite.',
|
|
72267
|
+
format: 'uuid',
|
|
72268
|
+
type: 'string',
|
|
72269
|
+
},
|
|
72270
|
+
favorite_id: {
|
|
72271
|
+
description:
|
|
72272
|
+
'ID of the favorite that you want to play, from `/speakers/list_favorites`.',
|
|
72273
|
+
minLength: 1,
|
|
72274
|
+
type: 'string',
|
|
72275
|
+
},
|
|
72276
|
+
shuffle: {
|
|
72277
|
+
description:
|
|
72278
|
+
"Whether to shuffle the favorite's tracks. If you omit this parameter, the speaker keeps its current shuffle setting.",
|
|
72279
|
+
type: 'boolean',
|
|
72280
|
+
},
|
|
72281
|
+
},
|
|
72282
|
+
required: ['device_id', 'favorite_id'],
|
|
72283
|
+
type: 'object',
|
|
72284
|
+
},
|
|
72285
|
+
},
|
|
72286
|
+
},
|
|
72287
|
+
},
|
|
72288
|
+
responses: {
|
|
72289
|
+
'200': {
|
|
72290
|
+
content: {
|
|
72291
|
+
'application/json': {
|
|
72292
|
+
schema: {
|
|
72293
|
+
properties: {
|
|
72294
|
+
action_attempt: {
|
|
72295
|
+
$ref: '#/components/schemas/action_attempt',
|
|
72296
|
+
},
|
|
72297
|
+
ok: { type: 'boolean' },
|
|
72298
|
+
},
|
|
72299
|
+
required: ['action_attempt', 'ok'],
|
|
72300
|
+
type: 'object',
|
|
72301
|
+
},
|
|
72302
|
+
},
|
|
72303
|
+
},
|
|
72304
|
+
description: 'OK',
|
|
72305
|
+
},
|
|
72306
|
+
'400': { description: 'Bad Request' },
|
|
72307
|
+
'401': { description: 'Unauthorized' },
|
|
72308
|
+
},
|
|
72309
|
+
security: [
|
|
72310
|
+
{ client_session: [] },
|
|
72311
|
+
{ pat_with_workspace: [] },
|
|
72312
|
+
{ console_session_with_workspace: [] },
|
|
72313
|
+
{ api_key: [] },
|
|
72314
|
+
],
|
|
72315
|
+
summary: '/speakers/play_favorite',
|
|
72316
|
+
tags: [],
|
|
72317
|
+
'x-action-attempt-type': 'PLAY_SPEAKER_FAVORITE',
|
|
72318
|
+
'x-fern-sdk-group-name': ['speakers'],
|
|
72319
|
+
'x-fern-sdk-method-name': 'play_favorite',
|
|
72320
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
72321
|
+
'x-response-key': 'action_attempt',
|
|
72322
|
+
'x-title': 'Play a Favorite on a Speaker',
|
|
72323
|
+
'x-undocumented': 'Unreleased.',
|
|
72324
|
+
},
|
|
72325
|
+
},
|
|
71636
72326
|
'/speakers/resume': {
|
|
71637
72327
|
post: {
|
|
71638
72328
|
description:
|