@seamapi/types 1.1125.0 → 1.1127.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.1125.0",
+  "version": "1.1127.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/action-attempts/action-attempt.ts

@@ -9,7 +9,9 @@ import { deprecated_action_attempts } from './deprecated.js'
 import { encode_credential_action_attempt } from './encode-credential.js'
 import { lock_door_action_attempt } from './lock-door.js'
 import { pause_speaker_playback_action_attempt } from './pause-speaker-playback.js'
+import { play_speaker_audio_clip_action_attempt } from './play-speaker-audio-clip.js'
 import { play_speaker_chime_action_attempt } from './play-speaker-chime.js'
+import { play_speaker_favorite_action_attempt } from './play-speaker-favorite.js'
 import { push_thermostat_programs_action_attempt } from './push-thermostat-programs.js'
 import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
 import { resume_speaker_playback_action_attempt } from './resume-speaker-playback.js'
@@ -45,6 +47,8 @@ export const action_attempt = z.union([
   ...pause_speaker_playback_action_attempt.options,
   ...resume_speaker_playback_action_attempt.options,
   ...play_speaker_chime_action_attempt.options,
+  ...play_speaker_favorite_action_attempt.options,
+  ...play_speaker_audio_clip_action_attempt.options,
   ...deprecated_action_attempts,
 ]).describe(`
   ---

package/src/lib/seam/connect/models/action-attempts/pause-speaker-playback.ts

@@ -6,11 +6,12 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z
-  .literal('PAUSE_SPEAKER_PLAYBACK')
-  .describe(
-    'Action attempt to track the status of pausing playback on a speaker.',
-  )
+const action_type = z.literal('PAUSE_SPEAKER_PLAYBACK').describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Action attempt to track the status of pausing playback on a speaker.
+    `)
 
 const error = z
   .object({
@@ -36,19 +37,28 @@ const result = z
 export const pause_speaker_playback_action_attempt = z.discriminatedUnion(
   'status',
   [
-    common_pending_action_attempt
-      .extend({
-        action_type,
-      })
-      .describe('Pausing playback on the speaker is pending.'),
-    common_succeeded_action_attempt
-      .extend({
-        action_type,
-        result,
-      })
-      .describe('Pausing playback on the speaker succeeded.'),
-    common_failed_action_attempt
-      .extend({ action_type, error })
-      .describe('Pausing playback on the speaker failed.'),
+    common_pending_action_attempt.extend({
+      action_type,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Pausing playback on the speaker is pending.
+    `),
+    common_succeeded_action_attempt.extend({
+      action_type,
+      result,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Pausing playback on the speaker succeeded.
+    `),
+    common_failed_action_attempt.extend({ action_type, error }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Pausing playback on the speaker failed.
+    `),
   ],
 )

package/src/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.ts

@@ -0,0 +1,56 @@
+import * as z from 'zod/v3'
+
+import {
+  common_failed_action_attempt,
+  common_pending_action_attempt,
+  common_succeeded_action_attempt,
+} from './common.js'
+
+const action_type = z.literal('PLAY_SPEAKER_AUDIO_CLIP').describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Action attempt to track the status of playing an audio clip on a speaker.
+    `)
+
+const error = z
+  .object({
+    type: z.string().describe('Type of the error.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error associated with the action.')
+
+const result = z.object({}).describe('Result of the action.')
+
+export const play_speaker_audio_clip_action_attempt = z.discriminatedUnion(
+  'status',
+  [
+    common_pending_action_attempt.extend({
+      action_type,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing an audio clip on the speaker is pending.
+    `),
+    common_succeeded_action_attempt.extend({
+      action_type,
+      result,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing an audio clip on the speaker succeeded.
+    `),
+    common_failed_action_attempt.extend({ action_type, error }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing an audio clip on the speaker failed.
+    `),
+  ],
+)

package/src/lib/seam/connect/models/action-attempts/play-speaker-chime.ts

@@ -6,11 +6,12 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z
-  .literal('PLAY_SPEAKER_CHIME')
-  .describe(
-    'Action attempt to track the status of playing a chime on a speaker.',
-  )
+const action_type = z.literal('PLAY_SPEAKER_CHIME').describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Action attempt to track the status of playing a chime on a speaker.
+    `)
 
 const error = z
   .object({
@@ -28,19 +29,28 @@ const result = z.object({}).describe('Result of the action.')
 export const play_speaker_chime_action_attempt = z.discriminatedUnion(
   'status',
   [
-    common_pending_action_attempt
-      .extend({
-        action_type,
-      })
-      .describe('Playing a chime on the speaker is pending.'),
-    common_succeeded_action_attempt
-      .extend({
-        action_type,
-        result,
-      })
-      .describe('Playing a chime on the speaker succeeded.'),
-    common_failed_action_attempt
-      .extend({ action_type, error })
-      .describe('Playing a chime on the speaker failed.'),
+    common_pending_action_attempt.extend({
+      action_type,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing a chime on the speaker is pending.
+    `),
+    common_succeeded_action_attempt.extend({
+      action_type,
+      result,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing a chime on the speaker succeeded.
+    `),
+    common_failed_action_attempt.extend({ action_type, error }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing a chime on the speaker failed.
+    `),
   ],
 )

package/src/lib/seam/connect/models/action-attempts/play-speaker-favorite.ts

@@ -0,0 +1,64 @@
+import * as z from 'zod/v3'
+
+import {
+  common_failed_action_attempt,
+  common_pending_action_attempt,
+  common_succeeded_action_attempt,
+} from './common.js'
+
+const action_type = z.literal('PLAY_SPEAKER_FAVORITE').describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Action attempt to track the status of playing a favorite on a speaker.
+    `)
+
+const error = z
+  .object({
+    type: z.string().describe('Type of the error.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error associated with the action.')
+
+const result = z
+  .object({
+    affected_device_ids: z
+      .array(z.string().uuid())
+      .describe(
+        'IDs of the speakers now playing the favorite, including speakers grouped with the requested speaker.',
+      ),
+  })
+  .describe('Result of the action.')
+
+export const play_speaker_favorite_action_attempt = z.discriminatedUnion(
+  'status',
+  [
+    common_pending_action_attempt.extend({
+      action_type,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing a favorite on the speaker is pending.
+    `),
+    common_succeeded_action_attempt.extend({
+      action_type,
+      result,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing a favorite on the speaker succeeded.
+    `),
+    common_failed_action_attempt.extend({ action_type, error }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Playing a favorite on the speaker failed.
+    `),
+  ],
+)

package/src/lib/seam/connect/models/action-attempts/resume-speaker-playback.ts

@@ -6,11 +6,12 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z
-  .literal('RESUME_SPEAKER_PLAYBACK')
-  .describe(
-    'Action attempt to track the status of resuming playback on a speaker.',
-  )
+const action_type = z.literal('RESUME_SPEAKER_PLAYBACK').describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Action attempt to track the status of resuming playback on a speaker.
+    `)
 
 const error = z
   .object({
@@ -36,19 +37,28 @@ const result = z
 export const resume_speaker_playback_action_attempt = z.discriminatedUnion(
   'status',
   [
-    common_pending_action_attempt
-      .extend({
-        action_type,
-      })
-      .describe('Resuming playback on the speaker is pending.'),
-    common_succeeded_action_attempt
-      .extend({
-        action_type,
-        result,
-      })
-      .describe('Resuming playback on the speaker succeeded.'),
-    common_failed_action_attempt
-      .extend({ action_type, error })
-      .describe('Resuming playback on the speaker failed.'),
+    common_pending_action_attempt.extend({
+      action_type,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Resuming playback on the speaker is pending.
+    `),
+    common_succeeded_action_attempt.extend({
+      action_type,
+      result,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Resuming playback on the speaker succeeded.
+    `),
+    common_failed_action_attempt.extend({ action_type, error }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Resuming playback on the speaker failed.
+    `),
   ],
 )

package/src/lib/seam/connect/models/action-attempts/set-speaker-mute.ts

@@ -6,11 +6,12 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z
-  .literal('SET_SPEAKER_MUTE')
-  .describe(
-    'Action attempt to track the status of muting or unmuting a speaker.',
-  )
+const action_type = z.literal('SET_SPEAKER_MUTE').describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Action attempt to track the status of muting or unmuting a speaker.
+    `)
 
 const error = z
   .object({
@@ -26,18 +27,27 @@ const error = z
 const result = z.object({}).describe('Result of the action.')
 
 export const set_speaker_mute_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt
-    .extend({
-      action_type,
-    })
-    .describe('Muting or unmuting the speaker is pending.'),
-  common_succeeded_action_attempt
-    .extend({
-      action_type,
-      result,
-    })
-    .describe('Muting or unmuting the speaker succeeded.'),
-  common_failed_action_attempt
-    .extend({ action_type, error })
-    .describe('Muting or unmuting the speaker failed.'),
+  common_pending_action_attempt.extend({
+    action_type,
+  }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Muting or unmuting the speaker is pending.
+    `),
+  common_succeeded_action_attempt.extend({
+    action_type,
+    result,
+  }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Muting or unmuting the speaker succeeded.
+    `),
+  common_failed_action_attempt.extend({ action_type, error }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Muting or unmuting the speaker failed.
+    `),
 ])

package/src/lib/seam/connect/models/action-attempts/set-speaker-volume.ts

@@ -6,11 +6,12 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z
-  .literal('SET_SPEAKER_VOLUME')
-  .describe(
-    'Action attempt to track the status of setting the volume on a speaker.',
-  )
+const action_type = z.literal('SET_SPEAKER_VOLUME').describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Action attempt to track the status of setting the volume on a speaker.
+    `)
 
 const error = z
   .object({
@@ -28,19 +29,28 @@ const result = z.object({}).describe('Result of the action.')
 export const set_speaker_volume_action_attempt = z.discriminatedUnion(
   'status',
   [
-    common_pending_action_attempt
-      .extend({
-        action_type,
-      })
-      .describe('Setting the speaker volume is pending.'),
-    common_succeeded_action_attempt
-      .extend({
-        action_type,
-        result,
-      })
-      .describe('Setting the speaker volume succeeded.'),
-    common_failed_action_attempt
-      .extend({ action_type, error })
-      .describe('Setting the speaker volume failed.'),
+    common_pending_action_attempt.extend({
+      action_type,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Setting the speaker volume is pending.
+    `),
+    common_succeeded_action_attempt.extend({
+      action_type,
+      result,
+    }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Setting the speaker volume succeeded.
+    `),
+    common_failed_action_attempt.extend({ action_type, error }).describe(`
+    ---
+    undocumented: Unreleased.
+    ---
+    Setting the speaker volume failed.
+    `),
   ],
 )

package/src/lib/seam/connect/models/devices/capability-properties/speaker.ts

@@ -58,7 +58,9 @@ export const speaker_capability_properties = z.object({
         ),
       supports_chime: z
         .boolean()
-        .describe('Indicates whether the speaker can play a chime.'),
+        .describe(
+          'Indicates whether the speaker can play a chime or an audio clip.',
+        ),
       volume_reported_at: z
         .string()
         .datetime()
@@ -70,6 +72,7 @@ export const speaker_capability_properties = z.object({
     .optional().describe(`
           ---
           property_group_key: speakers
+          undocumented: Unreleased.
           ---
           Audio state and capabilities of the speaker.
           `),

package/src/lib/seam/connect/models/devices/device-metadata.ts

@@ -1357,8 +1357,12 @@ export const device_metadata = z
           ),
       })
       .partial()
-      .optional()
-      .describe('Metadata for a Sonos speaker.'),
+      .optional().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Metadata for a Sonos speaker.
+      `),
   })
   .partial().describe(`
           ---

package/src/lib/seam/connect/models/devices/device.ts

@@ -111,24 +111,54 @@ export const device_capability_flags = z
       .describe(
         'Indicates whether the camera supports streaming live video through a camera live view session.',
       ),
-    can_set_speaker_volume: z
-      .boolean()
-      .describe('Indicates whether the speaker supports setting its volume.'),
-    can_mute_speaker: z
-      .boolean()
-      .describe('Indicates whether the speaker supports muting.'),
-    can_unmute_speaker: z
-      .boolean()
-      .describe('Indicates whether the speaker supports unmuting.'),
-    can_pause_speaker_playback: z
-      .boolean()
-      .describe('Indicates whether the speaker supports pausing playback.'),
-    can_resume_speaker_playback: z
-      .boolean()
-      .describe('Indicates whether the speaker supports resuming playback.'),
-    can_play_speaker_chime: z
-      .boolean()
-      .describe('Indicates whether the speaker supports playing a chime.'),
+    can_set_speaker_volume: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports setting its volume.
+      `),
+    can_mute_speaker: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports muting.
+      `),
+    can_unmute_speaker: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports unmuting.
+      `),
+    can_pause_speaker_playback: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports pausing playback.
+      `),
+    can_resume_speaker_playback: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports resuming playback.
+      `),
+    can_play_speaker_chime: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports playing a chime.
+      `),
+    can_play_speaker_favorite: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports listing and playing the favorites saved in the speaker manufacturer's app, such as playlists and radio stations.
+      `),
+    can_play_speaker_audio_clip: z.boolean().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+      Indicates whether the speaker supports playing an audio clip from a URL.
+      `),
   })
   .partial()