@seamapi/types 1.1124.0 → 1.1126.0

package/src/lib/seam/connect/openapi.ts

@@ -12437,6 +12437,240 @@ const openapi: OpenAPISpec = {
             ],
             type: 'object',
           },
+          {
+            description: 'Playing a favorite on the speaker is pending.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of playing a favorite on a speaker.',
+                enum: ['PLAY_SPEAKER_FAVORITE'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for pending action attempts.',
+                nullable: true,
+              },
+              result: {
+                description:
+                  'Result of the action attempt. Null for pending action attempts.',
+                nullable: true,
+              },
+              status: { enum: ['pending'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'result',
+              'error',
+              'action_type',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Playing a favorite on the speaker succeeded.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of playing a favorite on a speaker.',
+                enum: ['PLAY_SPEAKER_FAVORITE'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for successful action attempts.',
+                nullable: true,
+              },
+              result: {
+                description: 'Result of the action.',
+                properties: {
+                  affected_device_ids: {
+                    description:
+                      'IDs of the speakers now playing the favorite, including speakers grouped with the requested speaker.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
+                },
+                required: ['affected_device_ids'],
+                type: 'object',
+              },
+              status: { enum: ['success'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'error',
+              'action_type',
+              'result',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Playing a favorite on the speaker failed.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of playing a favorite on a speaker.',
+                enum: ['PLAY_SPEAKER_FAVORITE'],
+                type: 'string',
+              },
+              error: {
+                description: 'Error associated with the action.',
+                properties: {
+                  message: {
+                    description:
+                      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                    type: 'string',
+                  },
+                  type: { description: 'Type of the error.', type: 'string' },
+                },
+                required: ['type', 'message'],
+                type: 'object',
+              },
+              result: {
+                description:
+                  'Result of the action attempt. Null for failed action attempts.',
+                nullable: true,
+              },
+              status: { enum: ['error'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'result',
+              'action_type',
+              'error',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Playing an audio clip on the speaker is pending.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of playing an audio clip on a speaker.',
+                enum: ['PLAY_SPEAKER_AUDIO_CLIP'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for pending action attempts.',
+                nullable: true,
+              },
+              result: {
+                description:
+                  'Result of the action attempt. Null for pending action attempts.',
+                nullable: true,
+              },
+              status: { enum: ['pending'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'result',
+              'error',
+              'action_type',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Playing an audio clip on the speaker succeeded.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of playing an audio clip on a speaker.',
+                enum: ['PLAY_SPEAKER_AUDIO_CLIP'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for successful action attempts.',
+                nullable: true,
+              },
+              result: {
+                description: 'Result of the action.',
+                properties: {},
+                type: 'object',
+              },
+              status: { enum: ['success'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'error',
+              'action_type',
+              'result',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Playing an audio clip on the speaker failed.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of playing an audio clip on a speaker.',
+                enum: ['PLAY_SPEAKER_AUDIO_CLIP'],
+                type: 'string',
+              },
+              error: {
+                description: 'Error associated with the action.',
+                properties: {
+                  message: {
+                    description:
+                      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                    type: 'string',
+                  },
+                  type: { description: 'Type of the error.', type: 'string' },
+                },
+                required: ['type', 'message'],
+                type: 'object',
+              },
+              result: {
+                description:
+                  'Result of the action attempt. Null for failed action attempts.',
+                nullable: true,
+              },
+              status: { enum: ['error'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'result',
+              'action_type',
+              'error',
+            ],
+            type: 'object',
+          },
           {
             properties: {
               action_attempt_id: {
@@ -14977,13 +15211,17 @@ const openapi: OpenAPISpec = {
             type: 'boolean',
           },
           can_mute_speaker: {
-            description:
-              'Indicates whether the speaker supports muting and unmuting.',
+            description: 'Indicates whether the speaker supports muting.',
             type: 'boolean',
           },
           can_pause_speaker_playback: {
             description:
-              'Indicates whether the speaker supports pausing and resuming playback.',
+              'Indicates whether the speaker supports pausing playback.',
+            type: 'boolean',
+          },
+          can_play_speaker_audio_clip: {
+            description:
+              'Indicates whether the speaker supports playing an audio clip from a URL.',
             type: 'boolean',
           },
           can_play_speaker_chime: {
@@ -14991,6 +15229,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the speaker supports playing a chime.',
             type: 'boolean',
           },
+          can_play_speaker_favorite: {
+            description:
+              "Indicates whether the speaker supports listing and playing the favorites saved in the speaker manufacturer's app, such as playlists and radio stations.",
+            type: 'boolean',
+          },
           can_program_offline_access_codes: {
             description:
               'Indicates whether the device supports programming offline access codes.',
@@ -15026,6 +15269,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the device supports remote unlocking.',
             type: 'boolean',
           },
+          can_resume_speaker_playback: {
+            description:
+              'Indicates whether the speaker supports resuming playback.',
+            type: 'boolean',
+          },
           can_run_thermostat_programs: {
             description:
               'Indicates whether the thermostat supports running climate programs.',
@@ -15080,6 +15328,10 @@ const openapi: OpenAPISpec = {
               'Indicates whether the lock supports unlocking with an access code.',
             type: 'boolean',
           },
+          can_unmute_speaker: {
+            description: 'Indicates whether the speaker supports unmuting.',
+            type: 'boolean',
+          },
           capabilities_supported: {
             description:
               '\n        Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).\n        ',
@@ -17979,7 +18231,7 @@ const openapi: OpenAPISpec = {
                           },
                           supports_chime: {
                             description:
-                              'Indicates whether the speaker can play a chime.',
+                              'Indicates whether the speaker can play a chime or an audio clip.',
                             type: 'boolean',
                           },
                           volume: {
@@ -19759,13 +20011,17 @@ const openapi: OpenAPISpec = {
             type: 'boolean',
           },
           can_mute_speaker: {
-            description:
-              'Indicates whether the speaker supports muting and unmuting.',
+            description: 'Indicates whether the speaker supports muting.',
             type: 'boolean',
           },
           can_pause_speaker_playback: {
             description:
-              'Indicates whether the speaker supports pausing and resuming playback.',
+              'Indicates whether the speaker supports pausing playback.',
+            type: 'boolean',
+          },
+          can_play_speaker_audio_clip: {
+            description:
+              'Indicates whether the speaker supports playing an audio clip from a URL.',
             type: 'boolean',
           },
           can_play_speaker_chime: {
@@ -19773,6 +20029,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the speaker supports playing a chime.',
             type: 'boolean',
           },
+          can_play_speaker_favorite: {
+            description:
+              "Indicates whether the speaker supports listing and playing the favorites saved in the speaker manufacturer's app, such as playlists and radio stations.",
+            type: 'boolean',
+          },
           can_program_offline_access_codes: {
             description:
               'Indicates whether the device supports programming offline access codes.',
@@ -19808,6 +20069,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the device supports remote unlocking.',
             type: 'boolean',
           },
+          can_resume_speaker_playback: {
+            description:
+              'Indicates whether the speaker supports resuming playback.',
+            type: 'boolean',
+          },
           can_run_thermostat_programs: {
             description:
               'Indicates whether the thermostat supports running climate programs.',
@@ -19862,6 +20128,10 @@ const openapi: OpenAPISpec = {
               'Indicates whether the lock supports unlocking with an access code.',
             type: 'boolean',
           },
+          can_unmute_speaker: {
+            description: 'Indicates whether the speaker supports unmuting.',
+            type: 'boolean',
+          },
           device_provider_name: {
             description: 'Name of the device provider.',
             enum: [
@@ -39702,13 +39972,17 @@ const openapi: OpenAPISpec = {
             type: 'boolean',
           },
           can_mute_speaker: {
-            description:
-              'Indicates whether the speaker supports muting and unmuting.',
+            description: 'Indicates whether the speaker supports muting.',
             type: 'boolean',
           },
           can_pause_speaker_playback: {
             description:
-              'Indicates whether the speaker supports pausing and resuming playback.',
+              'Indicates whether the speaker supports pausing playback.',
+            type: 'boolean',
+          },
+          can_play_speaker_audio_clip: {
+            description:
+              'Indicates whether the speaker supports playing an audio clip from a URL.',
             type: 'boolean',
           },
           can_play_speaker_chime: {
@@ -39716,6 +39990,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the speaker supports playing a chime.',
             type: 'boolean',
           },
+          can_play_speaker_favorite: {
+            description:
+              "Indicates whether the speaker supports listing and playing the favorites saved in the speaker manufacturer's app, such as playlists and radio stations.",
+            type: 'boolean',
+          },
           can_program_offline_access_codes: {
             description:
               'Indicates whether the device supports programming offline access codes.',
@@ -39751,6 +40030,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the device supports remote unlocking.',
             type: 'boolean',
           },
+          can_resume_speaker_playback: {
+            description:
+              'Indicates whether the speaker supports resuming playback.',
+            type: 'boolean',
+          },
           can_run_thermostat_programs: {
             description:
               'Indicates whether the thermostat supports running climate programs.',
@@ -39805,6 +40089,10 @@ const openapi: OpenAPISpec = {
               'Indicates whether the lock supports unlocking with an access code.',
             type: 'boolean',
           },
+          can_unmute_speaker: {
+            description: 'Indicates whether the speaker supports unmuting.',
+            type: 'boolean',
+          },
           capabilities_supported: {
             description:
               '\n        Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).\n        ',
@@ -54769,8 +55057,12 @@ const openapi: OpenAPISpec = {
                   'can_stream_live_video',
                   'can_set_speaker_volume',
                   'can_mute_speaker',
+                  'can_unmute_speaker',
                   'can_pause_speaker_playback',
+                  'can_resume_speaker_playback',
                   'can_play_speaker_chime',
+                  'can_play_speaker_favorite',
+                  'can_play_speaker_audio_clip',
                 ],
                 type: 'string',
               },
@@ -54808,8 +55100,12 @@ const openapi: OpenAPISpec = {
                   'can_stream_live_video',
                   'can_set_speaker_volume',
                   'can_mute_speaker',
+                  'can_unmute_speaker',
                   'can_pause_speaker_playback',
+                  'can_resume_speaker_playback',
                   'can_play_speaker_chime',
+                  'can_play_speaker_favorite',
+                  'can_play_speaker_audio_clip',
                 ],
                 type: 'string',
               },
@@ -57072,8 +57368,12 @@ const openapi: OpenAPISpec = {
                   'can_stream_live_video',
                   'can_set_speaker_volume',
                   'can_mute_speaker',
+                  'can_unmute_speaker',
                   'can_pause_speaker_playback',
+                  'can_resume_speaker_playback',
                   'can_play_speaker_chime',
+                  'can_play_speaker_favorite',
+                  'can_play_speaker_audio_clip',
                 ],
                 type: 'string',
               },
@@ -57111,8 +57411,12 @@ const openapi: OpenAPISpec = {
                   'can_stream_live_video',
                   'can_set_speaker_volume',
                   'can_mute_speaker',
+                  'can_unmute_speaker',
                   'can_pause_speaker_playback',
+                  'can_resume_speaker_playback',
                   'can_play_speaker_chime',
+                  'can_play_speaker_favorite',
+                  'can_play_speaker_audio_clip',
                 ],
                 type: 'string',
               },
@@ -71413,6 +71717,90 @@ const openapi: OpenAPISpec = {
         'x-title': 'Update a Space',
       },
     },
+    '/speakers/list_favorites': {
+      get: {
+        description:
+          "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`.",
+        operationId: 'speakersListFavoritesGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'device_id',
+            required: true,
+            schema: {
+              description:
+                'ID of the speaker for which you want to list favorites.',
+              format: 'uuid',
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    speaker_favorites: {
+                      items: {
+                        properties: {
+                          description: {
+                            description:
+                              'Description of the favorite, such as its artist or station.',
+                            type: 'string',
+                          },
+                          favorite_id: {
+                            description:
+                              'ID of the favorite. Pass it to `/speakers/play_favorite`.',
+                            type: 'string',
+                          },
+                          image_url: {
+                            description: "URL of the favorite's artwork.",
+                            type: 'string',
+                          },
+                          name: {
+                            description: 'Name of the favorite.',
+                            type: 'string',
+                          },
+                          service_name: {
+                            description:
+                              'Name of the music service that provides the favorite.',
+                            type: 'string',
+                          },
+                        },
+                        required: ['favorite_id', 'name'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
+                  },
+                  required: ['speaker_favorites', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/speakers/list_favorites',
+        tags: [],
+        'x-fern-sdk-group-name': ['speakers'],
+        'x-fern-sdk-method-name': 'list_favorites',
+        'x-fern-sdk-return-value': 'speaker_favorites',
+        'x-response-key': 'speaker_favorites',
+        'x-title': 'List Speaker Favorites',
+        'x-undocumented': 'Unreleased.',
+      },
+    },
     '/speakers/mute': {
       post: {
         description:
@@ -71534,6 +71922,80 @@ const openapi: OpenAPISpec = {
         'x-undocumented': 'Unreleased.',
       },
     },
+    '/speakers/play_audio_clip': {
+      post: {
+        description:
+          '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`.',
+        operationId: 'speakersPlayAudioClipPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  audio_url: {
+                    description:
+                      '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.',
+                    format: 'uri',
+                    maxLength: 2048,
+                    type: 'string',
+                  },
+                  device_id: {
+                    description:
+                      'ID of the speaker on which you want to play the audio clip.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  volume: {
+                    description:
+                      "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.",
+                    format: 'float',
+                    type: 'number',
+                  },
+                },
+                required: ['device_id', 'audio_url'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: '#/components/schemas/action_attempt',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['action_attempt', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/speakers/play_audio_clip',
+        tags: [],
+        'x-action-attempt-type': 'PLAY_SPEAKER_AUDIO_CLIP',
+        'x-fern-sdk-group-name': ['speakers'],
+        'x-fern-sdk-method-name': 'play_audio_clip',
+        'x-fern-sdk-return-value': 'action_attempt',
+        'x-response-key': 'action_attempt',
+        'x-title': 'Play an Audio Clip on a Speaker',
+        'x-undocumented': 'Unreleased.',
+      },
+    },
     '/speakers/play_chime': {
       post: {
         description:
@@ -71601,10 +72063,82 @@ const openapi: OpenAPISpec = {
         'x-undocumented': 'Unreleased.',
       },
     },
+    '/speakers/play_favorite': {
+      post: {
+        description:
+          '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`.',
+        operationId: 'speakersPlayFavoritePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  device_id: {
+                    description:
+                      'ID of the speaker on which you want to play the favorite.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  favorite_id: {
+                    description:
+                      'ID of the favorite that you want to play, from `/speakers/list_favorites`.',
+                    minLength: 1,
+                    type: 'string',
+                  },
+                  shuffle: {
+                    description:
+                      "Whether to shuffle the favorite's tracks. If you omit this parameter, the speaker keeps its current shuffle setting.",
+                    type: 'boolean',
+                  },
+                },
+                required: ['device_id', 'favorite_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: '#/components/schemas/action_attempt',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['action_attempt', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/speakers/play_favorite',
+        tags: [],
+        'x-action-attempt-type': 'PLAY_SPEAKER_FAVORITE',
+        'x-fern-sdk-group-name': ['speakers'],
+        'x-fern-sdk-method-name': 'play_favorite',
+        'x-fern-sdk-return-value': 'action_attempt',
+        'x-response-key': 'action_attempt',
+        'x-title': 'Play a Favorite on a Speaker',
+        'x-undocumented': 'Unreleased.',
+      },
+    },
     '/speakers/resume': {
       post: {
         description:
-          'Resumes playback on a specified speaker. Playback also resumes on the speakers grouped with it, and the action attempt result lists every affected speaker. To check whether a speaker supports resuming playback, use `device.can_pause_speaker_playback`.',
+          'Resumes playback on a specified speaker. Playback also resumes on the speakers grouped with it, and the action attempt result lists every affected speaker. To check whether a speaker supports resuming playback, use `device.can_resume_speaker_playback`.',
         operationId: 'speakersResumePost',
         requestBody: {
           content: {
@@ -71732,7 +72266,7 @@ const openapi: OpenAPISpec = {
     '/speakers/unmute': {
       post: {
         description:
-          'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.can_mute_speaker`.',
+          'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.can_unmute_speaker`.',
         operationId: 'speakersUnmutePost',
         requestBody: {
           content: {