@seamapi/types 1.1125.0 → 1.1126.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.1125.0",
+  "version": "1.1126.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/play-speaker-audio-clip.ts

@@ -0,0 +1,46 @@
+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(
+    '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('Playing an audio clip on the speaker is pending.'),
+    common_succeeded_action_attempt
+      .extend({
+        action_type,
+        result,
+      })
+      .describe('Playing an audio clip on the speaker succeeded.'),
+    common_failed_action_attempt
+      .extend({ action_type, error })
+      .describe('Playing an audio clip on the speaker failed.'),
+  ],
+)

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

@@ -0,0 +1,54 @@
+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(
+    '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('Playing a favorite on the speaker is pending.'),
+    common_succeeded_action_attempt
+      .extend({
+        action_type,
+        result,
+      })
+      .describe('Playing a favorite on the speaker succeeded.'),
+    common_failed_action_attempt
+      .extend({ action_type, error })
+      .describe('Playing a favorite on the speaker 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()

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

@@ -129,6 +129,16 @@ export const device_capability_flags = z
     can_play_speaker_chime: z
       .boolean()
       .describe('Indicates whether the speaker supports playing a chime.'),
+    can_play_speaker_favorite: z
+      .boolean()
+      .describe(
+        "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(
+        'Indicates whether the speaker supports playing an audio clip from a URL.',
+      ),
   })
   .partial()