wavekat_platform_client/voice.rs
1//! Voice-product resources synced from the desktop daemon up to the
2//! platform.
3//!
4//! The first shipped marker is [`VoiceCalls`] — per-call metadata for
5//! the platform's `/voice/calls` history page (see
6//! `wavekat-voice/docs/21-platform-call-history-sync.md`). Recordings
7//! (`VoiceRecordings`), transcripts (`VoiceTranscripts`), and summaries
8//! will follow the same shape: a marker type, a wire-record struct, and
9//! a typed query — no new HTTP plumbing.
10//!
11//! All wire shapes use camelCase JSON to match the platform's Hono/Zod
12//! convention. The Rust types stay snake_case so consumers feel native.
13
14use serde::{Deserialize, Serialize};
15
16use crate::client::Client;
17use crate::error::{Error, Result};
18use crate::sign::ReleaseCredential;
19use crate::sync::{stamp_schema_version, HasSyncEnvelope, SyncEndpoint, SyncEnvelope, SyncRequest};
20
21/// Inbound vs. outbound. Wire-stable snake_case strings — never
22/// renumber or rename. New states (e.g. `internal`) would be a wire
23/// addition, not a replacement.
24#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
25#[serde(rename_all = "snake_case")]
26pub enum VoiceCallDirection {
27 Inbound,
28 Outbound,
29}
30
31/// User-visible disposition. Derived from [`VoiceCallEndReason`] by the
32/// daemon; the platform stores both, so future UI surfaces can read
33/// either without re-deriving.
34#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
35#[serde(rename_all = "snake_case")]
36pub enum VoiceCallDisposition {
37 Answered,
38 Missed,
39 Rejected,
40 Cancelled,
41 Failed,
42}
43
44/// Finer-grained terminal reason — kept distinct from
45/// [`VoiceCallDisposition`] because the disposition collapses
46/// `hangup_local` and `hangup_remote` to `Answered`, losing the
47/// "who hung up?" answer the row otherwise carries.
48///
49/// Wire-stable snake_case strings; the daemon's matching enum is the
50/// canonical source.
51#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
52#[serde(rename_all = "snake_case")]
53pub enum VoiceCallEndReason {
54 HangupLocal,
55 HangupRemote,
56 RejectedLocal,
57 RejectedRemote,
58 Missed,
59 CancelledLocal,
60 /// We blind-transferred the call to a third party (RFC 3515) and
61 /// dropped our own leg once the target answered. Distinct from
62 /// `HangupLocal`: the user didn't hang up, they handed the call off.
63 /// The destination is carried alongside in
64 /// [`VoiceCallRecord::transfer_target`]. Rows with this reason still
65 /// carry [`VoiceCallDisposition::Answered`].
66 TransferredLocal,
67 /// An established call torn down because its connection died —
68 /// the daemon's RFC 4028 session keepalive stopped getting
69 /// answers (peer crashed, NAT binding dropped). Distinct from
70 /// `HangupLocal`: the user didn't end this call. Rows with this
71 /// reason still carry [`VoiceCallDisposition::Answered`].
72 ConnectionLost,
73 Failed,
74}
75
76/// The audio codec a call negotiated, stamped once audio flows. Wire-
77/// stable snake_case strings matching the daemon's `CallCodec` enum —
78/// the platform validates against this exact list, so a rename here
79/// would bounce every upload with a 400. New codecs (e.g. `ilbc`) are
80/// wire additions, not replacements.
81///
82/// Consumers render this as a quality tier ("HD" for Opus, "Standard"
83/// for the G.711 pair), not the codec name alone — see the desktop
84/// client's call-details page for the canonical presentation.
85#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
86#[serde(rename_all = "snake_case")]
87pub enum VoiceCallCodec {
88 /// Opus wideband (16 kHz) — the "HD" tier.
89 Opus,
90 /// G.711 µ-law — the narrowband "Standard" tier.
91 Pcmu,
92 /// G.711 A-law — the narrowband "Standard" tier.
93 Pcma,
94}
95
96/// How a call flow's ("receptionist") run ended, folded by the daemon
97/// from the run's terminal trace step. Wire-stable snake_case strings
98/// matching `wavekat_flow::trace::FlowOutcome` — declared here rather
99/// than re-exported so this crate stays free of a `wavekat-flow`
100/// dependency; the two lists must be kept in step.
101///
102/// Consumers prefer this over [`VoiceCallEndReason`] when rendering a
103/// flow-answered call's outcome: the flow's own goodbye sends the BYE,
104/// so the SIP-level reason reads `HangupLocal` ("you hung up") for a
105/// call the user never touched.
106#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
107#[serde(rename_all = "snake_case")]
108pub enum VoiceCallFlowOutcome {
109 /// A `ring` node was answered by a human; the engine stepped out.
110 Answered,
111 /// A `message` node recorded a voicemail.
112 MessageLeft,
113 /// A `transfer` node handed the call to an external number.
114 Transferred,
115 /// A `hangup` node ended the call.
116 HungUp,
117 /// An effect failed mid-run (the call likely dropped).
118 Aborted,
119 /// The flow reached an impossible state. Validation is meant to
120 /// prevent this, so it signals a defect worth alerting on.
121 Defect,
122}
123
124/// One step of a call flow's run, as the daemon projects it from its
125/// local `call_flow_step` events.
126///
127/// Deliberately structural rather than a rendered sentence. The daemon
128/// has an English summary for each step, but the platform's web UI
129/// serves nine locales — shipping prose would make these permanently
130/// untranslatable there. Consumers get the parts and compose the
131/// sentence themselves.
132///
133/// `kind` is a plain `String`, not an enum, and that is the point: step
134/// kinds grow every time the flow engine gains a node type, and a
135/// consumer built against an older version of this crate must still be
136/// able to deserialize a newer daemon's trace. An unknown kind is
137/// rendered as an unnamed marker rather than rejected.
138#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
139#[serde(rename_all = "camelCase")]
140pub struct VoiceCallFlowStep {
141 /// Milliseconds from the call's answer time — the same zero the
142 /// recording starts at, so a step lines up with the audio.
143 pub at_ms: i64,
144 /// The engine's step tag: `spoke`, `hours`, `menu_choice`,
145 /// `menu_no_input`, `menu_invalid`, `ring`, `message_recorded`,
146 /// `transferred`, `hung_up`, or the synthetic `answered` marking a
147 /// mid-run take-over by the owner.
148 pub kind: String,
149 /// The flow node this step belongs to, when it names one.
150 #[serde(default, skip_serializing_if = "Option::is_none")]
151 pub node: Option<String>,
152 /// The key the caller pressed — `menu_choice` only.
153 #[serde(default, skip_serializing_if = "Option::is_none")]
154 pub digit: Option<String>,
155 /// Recorded message length in seconds — `message_recorded` only.
156 #[serde(default, skip_serializing_if = "Option::is_none")]
157 pub secs: Option<i64>,
158 /// Where the call was sent — `transferred` only.
159 #[serde(default, skip_serializing_if = "Option::is_none")]
160 pub target: Option<String>,
161 /// Whether an hours check landed inside business hours.
162 #[serde(default, skip_serializing_if = "Option::is_none")]
163 pub open: Option<bool>,
164 /// Whether a `ring` step was picked up.
165 #[serde(default, skip_serializing_if = "Option::is_none")]
166 pub answered: Option<bool>,
167}
168
169/// One historical call as it crosses the wire from the daemon up to the
170/// platform.
171///
172/// Mirrors the daemon's local `CallRecord` (see
173/// `wavekat-voice/crates/wavekat-voice/src/db.rs`) with one rename:
174/// the daemon's local primary key (`id`) is shipped as `source_id`
175/// because the platform allocates its own row id and treats the
176/// daemon-side UUID as the idempotency key.
177#[derive(Debug, Clone, Serialize, Deserialize)]
178#[serde(rename_all = "camelCase")]
179pub struct VoiceCallRecord {
180 /// Daemon-generated UUID. The platform's `(user_id, source_id)`
181 /// upsert key — re-syncing the same id is a no-op.
182 pub source_id: String,
183 /// SIP account UUID on the daemon side. Opaque to the platform.
184 pub account_id: String,
185 pub direction: VoiceCallDirection,
186 /// SIP `From:` (inbound) or `To:` (outbound). Free text — caller
187 /// IDs, display names, and SIP URIs all land here.
188 pub party: String,
189 /// RFC 3339. First ring (inbound) or first dial-out (outbound).
190 pub ring_at: String,
191 /// RFC 3339. Present only when the call reached the answered
192 /// state.
193 #[serde(default, skip_serializing_if = "Option::is_none")]
194 pub answer_at: Option<String>,
195 /// RFC 3339. Terminal timestamp; the platform uses this as the
196 /// list cursor.
197 pub end_at: String,
198 /// `answer_at` → `end_at` in milliseconds. `None` for calls that
199 /// were never answered.
200 #[serde(default, skip_serializing_if = "Option::is_none")]
201 pub duration_ms: Option<i64>,
202 pub disposition: VoiceCallDisposition,
203 pub end_reason: VoiceCallEndReason,
204 /// Free-text error, populated only when `disposition == Failed`.
205 #[serde(default, skip_serializing_if = "Option::is_none")]
206 pub error: Option<String>,
207 /// Visibility tier of any *active* (not revoked / expired) share on this
208 /// call's recording, or `None` when it isn't shared. Read-only: the
209 /// platform sets it on list (`GET /api/voice/calls`) and detail responses
210 /// so a consumer can badge the row "Public" / "Invited only"; it is
211 /// skipped on serialize, so syncing a call never sends it. `Private` never
212 /// appears here — an unshared call is `None`.
213 #[serde(default, skip_serializing_if = "Option::is_none")]
214 pub share_visibility: Option<ShareVisibility>,
215 /// Where a transferred call was sent — the number or SIP address the
216 /// far end was asked to call (RFC 3515 `Refer-To`). Set only when
217 /// `end_reason == TransferredLocal`; `None` for every other call.
218 /// Unlike `share_visibility` this is daemon-owned data, so it *is*
219 /// sent on sync (serialized when present) and echoed back on read.
220 #[serde(default, skip_serializing_if = "Option::is_none")]
221 pub transfer_target: Option<String>,
222 /// The negotiated audio codec, present when the call reached the
223 /// audio-flowing state on a daemon new enough to record it; `None`
224 /// for never-answered calls and rows synced by older daemons. Like
225 /// `transfer_target` this is daemon-owned data, so it *is* sent on
226 /// sync (serialized when present) and echoed back on read.
227 #[serde(default, skip_serializing_if = "Option::is_none")]
228 pub codec: Option<VoiceCallCodec>,
229 /// Which call flow ("receptionist") answered this call, when one
230 /// did: the platform flow id the daemon held at answer time, and
231 /// the flow's display name *at that moment*. The name is shipped
232 /// verbatim rather than resolved from the flow on read, so a later
233 /// rename or delete doesn't rewrite what history says happened.
234 /// Both `None` for calls the user answered themselves. Daemon-owned
235 /// data like `codec`, so both are sent on sync and echoed on read.
236 #[serde(default, skip_serializing_if = "Option::is_none")]
237 pub flow_id: Option<String>,
238 #[serde(default, skip_serializing_if = "Option::is_none")]
239 pub flow_name: Option<String>,
240 /// How the flow's run ended. `None` when no flow answered, and for
241 /// runs with no terminal step (the caller hung up mid-flow) — there
242 /// [`VoiceCallRecord::end_reason`] is already the honest story.
243 #[serde(default, skip_serializing_if = "Option::is_none")]
244 pub flow_outcome: Option<VoiceCallFlowOutcome>,
245 /// The flow run's step-by-step trace, in answer-time order. Drives
246 /// the markers the platform's call-detail page draws on the
247 /// recording waveform.
248 ///
249 /// `None` for human-answered calls and for daemons predating the
250 /// trace. Sent on sync like the other daemon-owned fields, but
251 /// echoed back only on the *detail* read (`GET /api/voice/calls/
252 /// {sourceId}`) — the list route omits it, since nothing on a list
253 /// row renders a trace and it would weigh down every page.
254 #[serde(default, skip_serializing_if = "Option::is_none")]
255 pub flow_steps: Option<Vec<VoiceCallFlowStep>>,
256 /// RFC 3339 soft-delete tombstone. `None` = live; `Some` = the user
257 /// deleted this call at that time.
258 ///
259 /// Calls are otherwise immutable one-way pushes, and this is the
260 /// single exception: a delete has to reach the platform somehow, and
261 /// a hard `DELETE` can't sync under a "push the row" model — once
262 /// the row is gone there's nothing left to push. So a delete rides
263 /// as an ordinary upsert with this field set, exactly like
264 /// [`VoiceAccountRecord::deleted_at`].
265 ///
266 /// Where it differs from the account tombstone: **the platform
267 /// treats this one as sticky, not last-write-wins.** An account is
268 /// genuinely mutable, so it carries `updated_at` and conflicts
269 /// resolve on it; a call has no such field because delete is the
270 /// only mutation it has. The platform resolves the column
271 /// `COALESCE(existing, incoming)`, so once a call is deleted a
272 /// later sync of the same `source_id` can never revive it — which
273 /// also means a consumer must not expect to "undelete" by syncing
274 /// the row again with `None`.
275 ///
276 /// Deleting a call is not only a flag on the platform side: the
277 /// recording bytes are removed from object storage, the recording
278 /// and transcript rows are dropped, and any live share link is
279 /// revoked (it answers 410 thereafter). The tombstone row is
280 /// retained so a late-syncing device still learns about the delete
281 /// — read it via `include_deleted` on
282 /// [`VoiceCallsQuery`]. `GET /api/voice/calls/{sourceId}` returns
283 /// 404 for a deleted call rather than echoing the tombstone.
284 #[serde(default, skip_serializing_if = "Option::is_none")]
285 pub deleted_at: Option<String>,
286 /// Version + forward-compat fields shared by every sync record.
287 /// Flattened so `schemaVersion` and `extras` sit at the top of
288 /// the JSON object alongside the other columns. See
289 /// [`SyncEnvelope`] and doc 21 §"Versioning and forward
290 /// compatibility".
291 #[serde(flatten, default)]
292 pub envelope: SyncEnvelope,
293}
294
295/// Query params for `GET /api/voice/calls`. All fields optional — the
296/// default returns the newest page.
297#[derive(Debug, Clone, Default, Serialize, Deserialize)]
298#[serde(rename_all = "camelCase")]
299pub struct VoiceCallsQuery {
300 /// Include soft-deleted tombstones in the response. Absent / false
301 /// returns only live calls — what a human-facing list wants. A
302 /// delta-syncing device sets this `true` to learn about deletes
303 /// made on another device or on the web, so it can reap its local
304 /// copy.
305 ///
306 /// Unlike [`VoiceAccountsQuery::include_deleted`] there is no
307 /// "restore a fresh device" use for this: a tombstoned call has had
308 /// its recording and transcript destroyed, so the only thing left
309 /// to learn from it is that it's gone.
310 #[serde(default, skip_serializing_if = "Option::is_none")]
311 pub include_deleted: Option<bool>,
312 /// RFC 3339 cursor; rows with `end_at < before` are returned.
313 #[serde(default, skip_serializing_if = "Option::is_none")]
314 pub before: Option<String>,
315 /// 1..=200. Server default is 50.
316 #[serde(default, skip_serializing_if = "Option::is_none")]
317 pub limit: Option<u32>,
318}
319
320/// Marker for the `/api/voice/calls/{sync,list}` endpoint pair.
321///
322/// Use as a type parameter, never construct: `client.sync::<VoiceCalls>(&items)`.
323pub struct VoiceCalls;
324
325impl SyncEndpoint for VoiceCalls {
326 const RESOURCE: &'static str = "calls";
327 type Record = VoiceCallRecord;
328 type Query = VoiceCallsQuery;
329}
330
331impl HasSyncEnvelope for VoiceCallRecord {
332 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
333 &mut self.envelope
334 }
335}
336
337// ---- VoiceRecordings ------------------------------------------------------
338
339/// One per-call recording's metadata as it crosses the wire from the
340/// daemon up to the platform. The WAV bytes ride on a separate
341/// follow-up call ([`Client::upload_recording_bytes`]) so the
342/// idempotent metadata sync stays small and a flaky bytes upload
343/// doesn't force the daemon to re-ship the row.
344///
345/// Mirrors the daemon's `RecordingArtifact` (see
346/// `wavekat-voice/crates/wavekat-voice/src/recording.rs`) with one
347/// rename: the daemon's local id (`id`) ships as `source_id` because
348/// the platform allocates its own row id and treats the daemon-side
349/// UUID as the idempotency key (same convention as
350/// [`VoiceCallRecord`]).
351#[derive(Debug, Clone, Serialize, Deserialize)]
352#[serde(rename_all = "camelCase")]
353pub struct VoiceRecordingRecord {
354 /// Daemon-generated UUID for this recording artifact. Upsert key
355 /// on the platform side.
356 pub source_id: String,
357 /// Daemon's `calls.id` — the call this recording belongs to.
358 /// The platform stores both so the /voice/calls history page can
359 /// link a call to its recording without a separate join table.
360 pub call_source_id: String,
361 /// Byte length of the WAV file the daemon will PUT in the follow-
362 /// up bytes call. The platform refuses a PUT whose body length
363 /// disagrees.
364 pub size_bytes: u64,
365 pub duration_ms: u64,
366 pub sample_rate: u32,
367 pub channels: u16,
368 /// RFC 3339 timestamp the daemon stamped on the artifact at
369 /// finalize time. Drives the platform's `/voice/recordings` GET
370 /// cursor.
371 pub created_at: String,
372 #[serde(flatten, default)]
373 pub envelope: SyncEnvelope,
374}
375
376/// Query params for `GET /api/voice/recordings`.
377#[derive(Debug, Clone, Default, Serialize, Deserialize)]
378#[serde(rename_all = "camelCase")]
379pub struct VoiceRecordingsQuery {
380 /// RFC 3339 cursor; rows with `created_at < before` are returned.
381 #[serde(default, skip_serializing_if = "Option::is_none")]
382 pub before: Option<String>,
383 #[serde(default, skip_serializing_if = "Option::is_none")]
384 pub limit: Option<u32>,
385}
386
387/// Marker for the `/api/voice/recordings/{sync,list}` endpoint pair.
388///
389/// The corresponding bytes-upload endpoint
390/// (`PUT /api/voice/recordings/{sourceId}/bytes`) is invoked via
391/// [`Client::upload_recording_bytes`] — it doesn't fit the
392/// `SyncEndpoint` mold (no batch, no JSON body) so it has its own
393/// inherent method on `Client`.
394pub struct VoiceRecordings;
395
396impl SyncEndpoint for VoiceRecordings {
397 const RESOURCE: &'static str = "recordings";
398 type Record = VoiceRecordingRecord;
399 type Query = VoiceRecordingsQuery;
400}
401
402impl HasSyncEnvelope for VoiceRecordingRecord {
403 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
404 &mut self.envelope
405 }
406}
407
408/// One item in the platform's response to
409/// `POST /api/voice/recordings/sync`. Lets the daemon learn the R2
410/// key the platform stamped (so a subsequent bytes PUT can target it)
411/// without re-deriving it, and check whether bytes have already
412/// landed on a prior cycle (so the daemon can mark the local row
413/// synced without re-uploading the WAV).
414#[derive(Debug, Clone, Serialize, Deserialize)]
415#[serde(rename_all = "camelCase")]
416pub struct VoiceRecordingSyncItem {
417 pub source_id: String,
418 pub r2_key: String,
419 pub bytes_uploaded: bool,
420}
421
422/// Full response from `POST /api/voice/recordings/sync`. Superset of
423/// the generic [`crate::SyncResponse`] — see [`Client::sync_recordings`].
424#[derive(Debug, Clone, Serialize, Deserialize)]
425#[serde(rename_all = "camelCase")]
426pub struct VoiceRecordingsSyncResponse {
427 pub accepted: u32,
428 pub skipped: u32,
429 pub items: Vec<VoiceRecordingSyncItem>,
430}
431
432// ---- VoiceTranscripts -----------------------------------------------------
433
434/// Wire-stable transcript channel tag. Matches the daemon's
435/// `TranscriptChannelLabel` and `events::TranscriptChannel`.
436#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
437#[serde(rename_all = "snake_case")]
438pub enum VoiceTranscriptChannel {
439 /// Local mic audio — what the user said.
440 Local,
441 /// Received RTP audio — what the remote party said.
442 Remote,
443}
444
445/// One ASR transcript segment ("final" in wavekat-asr parlance) as it
446/// crosses the wire. Each segment is a row on the daemon side
447/// (`transcripts` table); the daemon batches a slice of them per
448/// upload and the platform upserts per (user_id, source_id).
449#[derive(Debug, Clone, Serialize, Deserialize)]
450#[serde(rename_all = "camelCase")]
451pub struct VoiceTranscriptRecord {
452 /// Daemon-side row id, formatted as text (the column is an
453 /// autoincrement integer on SQLite). Stable per (call, segment)
454 /// so re-shipping converges.
455 pub source_id: String,
456 /// Daemon's `calls.id` — the call this segment belongs to.
457 pub call_source_id: String,
458 pub channel: VoiceTranscriptChannel,
459 /// Start of the segment in milliseconds relative to the start of
460 /// the call's audio stream (not wall-clock).
461 pub ts_ms: i64,
462 /// End of the segment, same reference frame as `ts_ms`.
463 pub end_ms: i64,
464 /// Recognised text. Free-form; the platform stores it verbatim.
465 pub text: String,
466 #[serde(flatten, default)]
467 pub envelope: SyncEnvelope,
468}
469
470/// Query params for `GET /api/voice/transcripts` — required
471/// `call_source_id` (the endpoint refuses a flat list).
472#[derive(Debug, Clone, Default, Serialize, Deserialize)]
473#[serde(rename_all = "camelCase")]
474pub struct VoiceTranscriptsQuery {
475 pub call_source_id: String,
476}
477
478/// Marker for the `/api/voice/transcripts/{sync,list}` endpoint pair.
479pub struct VoiceTranscripts;
480
481impl SyncEndpoint for VoiceTranscripts {
482 const RESOURCE: &'static str = "transcripts";
483 type Record = VoiceTranscriptRecord;
484 type Query = VoiceTranscriptsQuery;
485}
486
487impl HasSyncEnvelope for VoiceTranscriptRecord {
488 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
489 &mut self.envelope
490 }
491}
492
493// ---- VoiceAccounts --------------------------------------------------------
494
495/// SIP transport for a synced account line. Wire-stable snake_case;
496/// mirrors the daemon's `TransportKind`.
497#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
498#[serde(rename_all = "snake_case")]
499pub enum VoiceTransport {
500 Udp,
501 Tcp,
502}
503
504/// One SIP account line's *configuration* as it crosses the wire from a
505/// device up to the platform and back down to another device
506/// (`wavekat-voice/docs/40-account-config-sync.md`).
507///
508/// Unlike calls / recordings / transcripts — which are immutable,
509/// one-way pushes — account config is **mutable and bidirectional**: a
510/// line is edited, toggled, renamed, and deleted, and those changes must
511/// restore onto a second device. The same idempotent
512/// `(user_id, source_id)` upsert that [`Client::sync`] performs carries
513/// every kind of change here; a *delete* is a soft-delete that rides as
514/// an upsert with `deleted_at` set, because a hard DELETE can't sync
515/// under a "push the row" model — once the row is gone there's nothing
516/// left to push.
517///
518/// **No secret field, by construction.** The SIP password never appears
519/// on this wire. Config sync (policy levels 1–2) keeps the credential
520/// device-local, and the end-to-end-encrypted secret path (level 3)
521/// ships its ciphertext through a *separate* opaque resource, never as a
522/// field here. Omitting it means level 3 can't be populated by accident
523/// before it exists.
524#[derive(Debug, Clone, Serialize, Deserialize)]
525#[serde(rename_all = "camelCase")]
526pub struct VoiceAccountRecord {
527 /// Daemon-side account UUID (`accounts.id`). The platform's
528 /// `(user_id, source_id)` upsert key — re-syncing the same id
529 /// updates the row in place (mutable), unlike the immutable
530 /// resources where a re-sync is a no-op.
531 pub source_id: String,
532 /// Whether the line registers on daemon boot. Pausing a line is a
533 /// portable preference, so it rides along.
534 pub enabled: bool,
535 pub display_name: String,
536 pub username: String,
537 pub domain: String,
538 #[serde(default, skip_serializing_if = "Option::is_none")]
539 pub auth_username: Option<String>,
540 #[serde(default, skip_serializing_if = "Option::is_none")]
541 pub server: Option<String>,
542 #[serde(default, skip_serializing_if = "Option::is_none")]
543 pub port: Option<u16>,
544 pub transport: VoiceTransport,
545 pub register_expires: u32,
546 #[serde(default, skip_serializing_if = "Option::is_none")]
547 pub keepalive_secs: Option<u32>,
548 /// Record-disclosure beep toggle — a column on the account row, so
549 /// it rides along for free (the account-portable taxonomy in doc 40).
550 pub disclosure_enabled: bool,
551 /// RFC 3339 last-modification time — the **last-write-wins key**. On
552 /// conflict the platform (and a pulling client) keep the copy with
553 /// the later `updated_at`. Whole-row LWW for v1; per-field merge is
554 /// deferred until users actually report lost edits (doc 40).
555 pub updated_at: String,
556 /// RFC 3339 soft-delete tombstone. `None` = live; `Some` = the line
557 /// was deleted on some device at that time. A tombstone syncs like
558 /// any other mutation so the delete propagates to other devices,
559 /// then is reaped locally once confirmed. The platform retains
560 /// tombstones so a late-syncing device still learns about the delete.
561 #[serde(default, skip_serializing_if = "Option::is_none")]
562 pub deleted_at: Option<String>,
563 /// Version + forward-compat fields shared by every sync record.
564 #[serde(flatten, default)]
565 pub envelope: SyncEnvelope,
566}
567
568/// Query params for `GET /api/voice/accounts`. All fields optional.
569#[derive(Debug, Clone, Default, Serialize, Deserialize)]
570#[serde(rename_all = "camelCase")]
571pub struct VoiceAccountsQuery {
572 /// Include soft-deleted tombstones in the response. Absent / false
573 /// returns only live lines — the restore-grade pull a fresh device
574 /// wants. A delta-syncing device sets this `true` to also learn
575 /// about deletes made elsewhere (doc 40).
576 #[serde(default, skip_serializing_if = "Option::is_none")]
577 pub include_deleted: Option<bool>,
578}
579
580/// Marker for the `/api/voice/accounts/{sync,list}` endpoint pair.
581///
582/// Accounts are the first *mutable, bidirectional* sync resource, but
583/// the wire shape is the same idempotent upsert the immutable resources
584/// use — the [`SyncResponse::skipped`](crate::sync::SyncResponse) field
585/// was reserved for exactly this case — so no new HTTP plumbing is
586/// needed: `client.sync::<VoiceAccounts>(&items)` uploads (including
587/// tombstones), `client.list::<VoiceAccounts>(&query)` pulls.
588pub struct VoiceAccounts;
589
590impl SyncEndpoint for VoiceAccounts {
591 const RESOURCE: &'static str = "accounts";
592 type Record = VoiceAccountRecord;
593 type Query = VoiceAccountsQuery;
594}
595
596impl HasSyncEnvelope for VoiceAccountRecord {
597 fn envelope_mut(&mut self) -> &mut SyncEnvelope {
598 &mut self.envelope
599 }
600}
601
602// ---- VoiceFlows (published pull) -------------------------------------------
603//
604// The daemon-facing pull leg of the call-flow ("Receptionist") system —
605// `wavekat-voice/docs/48-ivr-call-flows.md`'s control-plane split. Flows
606// are *authored* on the platform (drafts, publish gate, version
607// history); the daemon only ever reads the published snapshots, caches
608// them locally, and runs them offline. There is no upload direction, so
609// this is not a `SyncEndpoint` (that trait models the `{resource}/sync`
610// + list pair): it's a single typed GET, like the share commands above.
611
612/// One published call-flow snapshot as served by
613/// `GET /api/voice/flows/published`: the latest published version of a
614/// flow the bearer authored. The YAML carries the platform-stamped
615/// `id`/`name`/`version` and is served verbatim — the daemon re-parses
616/// and re-validates it on load rather than trusting the wire.
617#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
618#[serde(rename_all = "camelCase")]
619pub struct VoiceFlowRecord {
620 /// Platform-assigned flow id (`flow_…`), stable across versions.
621 pub id: String,
622 pub name: String,
623 /// Latest published version number (1-based, bumps on publish).
624 pub version: u32,
625 /// The immutable published document, verbatim.
626 pub yaml: String,
627 /// RFC 3339 time this version was published.
628 pub published_at: String,
629}
630
631/// Query params for `GET /api/voice/flows/published`. Cursor-paginated
632/// by flow id ascending; pass the previous page's `next_after` until it
633/// comes back `None` to collect the full set. The full set is what the
634/// daemon's reconcile wants — a cached flow absent from a complete pull
635/// was deleted on the platform.
636#[derive(Debug, Clone, Default, Serialize, Deserialize)]
637#[serde(rename_all = "camelCase")]
638pub struct VoiceFlowsQuery {
639 #[serde(default, skip_serializing_if = "Option::is_none")]
640 pub after: Option<String>,
641 /// Page size, server-capped at 100. `None` = server default (50).
642 #[serde(default, skip_serializing_if = "Option::is_none")]
643 pub limit: Option<u32>,
644 /// The document versions this caller's flow engine can run —
645 /// `wavekat_flow::SUPPORTED_SCHEMA_VERSIONS`, comma-separated
646 /// ascending ("1,2"). The platform withholds documents in any other
647 /// version rather than serving one the caller would fail to parse.
648 ///
649 /// **Send it.** `None` does not mean "anything goes": the platform
650 /// reads a missing value as version 1 only, because this parameter
651 /// arrived alongside version 2 and a caller that omits it is an
652 /// older build. A client that can run a newer version and stays
653 /// quiet silently loses those flows.
654 //
655 // Explicitly renamed: the struct is camelCase overall, but this
656 // route's query parameter is `schema_versions`, and a silently
657 // camelCased key would be ignored by the server — which reads
658 // exactly like a platform that has no such flows.
659 #[serde(
660 rename = "schema_versions",
661 default,
662 skip_serializing_if = "Option::is_none"
663 )]
664 pub schema_versions: Option<String>,
665}
666
667/// One page of published flow snapshots.
668#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
669#[serde(rename_all = "camelCase")]
670pub struct VoiceFlowsPage {
671 pub items: Vec<VoiceFlowRecord>,
672 /// Cursor for the next page; `None` = end of the set.
673 #[serde(default)]
674 pub next_after: Option<String>,
675}
676
677/// One frozen audio asset of a published flow version, as served by
678/// `GET /api/voice/flows/{id}/versions/{version}/assets` (wavekat-platform
679/// docs 16/17). The bytes were copied into a version-owned R2 object at
680/// publish time and never change, so `content_hash` identifies them
681/// exactly — the daemon diffs its local cache against it rather than
682/// trusting a bare filename, because the *same* `ref` can carry different
683/// bytes across two versions of the same flow.
684#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
685#[serde(rename_all = "camelCase")]
686pub struct VoiceFlowVersionAsset {
687 /// The `vprompt_…` reference exactly as it appears in the flow YAML.
688 #[serde(rename = "ref")]
689 pub asset_ref: String,
690 /// Source telephony format the clip was frozen as (`ulaw_8000`,
691 /// `pcm_16000`, `mp3`, …); the container is WAV unless `mp3`.
692 pub format: String,
693 /// Size of the frozen bytes.
694 pub byte_size: u64,
695 /// Clip duration if the platform knew it at freeze time.
696 #[serde(default)]
697 pub duration_ms: Option<u64>,
698 /// sha256 of the frozen bytes — the cache's content key.
699 pub content_hash: String,
700}
701
702/// The frozen-asset manifest for one published version. Not paginated:
703/// a flow's asset count is bounded by its node count (a phone tree is
704/// tens of clips), so the platform returns them all in one response.
705#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
706#[serde(rename_all = "camelCase")]
707pub struct VoiceFlowAssetsPage {
708 pub assets: Vec<VoiceFlowVersionAsset>,
709}
710
711// ---- System flows (public, unauthenticated) --------------------------------
712//
713// The platform's curated set of ready-made call flows, served to every
714// device — signed in or not — and cached locally for offline use. These
715// are distinct from a user's own authored flows (the published-flows
716// endpoint above) and are read-only to clients; the flows are authored
717// on the platform and have no upload direction. Keyed by language tier
718// and published schema version (spec §5, doc 48 amendment 2026-08-27).
719
720/// One system (ready-made) call-flow record as served by the unauthenticated
721/// `GET /api/voice/flows/system?language=…&schema_versions=…` endpoint.
722/// Public by design — a signed-out device lists the catalogue and may
723/// preview, cache, and arm from it (gated by entitlement at arming time).
724///
725/// `description`, `publishedAt`, and `systemTags` may be absent on older
726/// rows or when the platform withheld them; all are optional.
727///
728/// A consumer has to be able to *name* this type — to map a record into its
729/// own cache row, or to build one in a fixture — not merely receive it by
730/// inference from [`Client::system_flows`]. This example is that guarantee:
731/// a doctest compiles as a downstream crate, so it fails if the type ever
732/// stops being re-exported from the crate root. The unit tests below cannot
733/// catch that, because inside the crate the private `voice` module is always
734/// in scope — which is exactly how 0.0.26 through 0.0.28 shipped these two
735/// types unreachable.
736///
737/// ```
738/// use wavekat_platform_client::{VoiceSystemFlowRecord, VoiceSystemFlowsPage};
739///
740/// let page: VoiceSystemFlowsPage = serde_json::from_str(
741/// r#"{"flows":[{"id":"flow_voicemail","name":"Voicemail","description":"",
742/// "language":"en","version":2,"yaml":"schema_version: 1\n",
743/// "publishedAt":null,"access":"open","systemTags":["system"]}]}"#,
744/// )
745/// .unwrap();
746/// let first: &VoiceSystemFlowRecord = &page.flows[0];
747/// assert_eq!(first.access, "open");
748/// ```
749#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
750#[serde(rename_all = "camelCase")]
751pub struct VoiceSystemFlowRecord {
752 /// Platform-assigned flow id (`flow_…`), stable across versions.
753 pub id: String,
754 pub name: String,
755 /// Optional short description of what the flow does.
756 #[serde(default)]
757 pub description: String,
758 /// BCP-47-ish language tag — the tier this flow was selected in by
759 /// the device's language preference.
760 pub language: String,
761 /// Published version number (1-based).
762 pub version: u32,
763 /// The immutable published YAML document, verbatim.
764 pub yaml: String,
765 /// When this version was published, **verbatim from the platform's D1
766 /// column** — which defaults to SQLite `CURRENT_TIMESTAMP` and so is
767 /// `"YYYY-MM-DD HH:MM:SS"` in UTC, *not* RFC 3339 (space separator, no
768 /// offset). Some rows do carry RFC 3339. Consumers must accept **both**:
769 /// a strict RFC 3339 parse is how every pulled flow once rendered as
770 /// "Updated Jan 1, 1970" in the desktop client. Absent on older rows.
771 #[serde(default)]
772 pub published_at: Option<String>,
773 /// Platform-resolved arming rung. One of `"open"`, `"account"`, `"pro"`,
774 /// or an unknown value (forward-compat for new platform rungs). Unknown
775 /// values are treated as the strictest known rung at arm time.
776 pub access: String,
777 /// Raw platform tags, preserved verbatim so a future feature can read
778 /// a new tag without a daemon release.
779 #[serde(default)]
780 pub system_tags: Vec<String>,
781}
782
783/// One page of system flows as served by
784/// `GET /api/voice/flows/system?language=…&schema_versions=…`.
785#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
786#[serde(rename_all = "camelCase")]
787pub struct VoiceSystemFlowsPage {
788 pub flows: Vec<VoiceSystemFlowRecord>,
789}
790
791impl Client {
792 /// `GET /api/voice/flows/published` — one page of the caller's
793 /// published flow snapshots (latest version each). Strictly
794 /// creator-scoped server-side; never returns another user's flows.
795 pub async fn published_flows(&self, query: &VoiceFlowsQuery) -> Result<VoiceFlowsPage> {
796 self.get_json_query::<VoiceFlowsPage, _>("/api/voice/flows/published", query)
797 .await
798 }
799
800 /// `GET /api/voice/flows/{id}/versions/{version}/assets` — the frozen
801 /// audio manifest for one published version (docs 16/17). Flow-scoped
802 /// server-side: a version of a flow the caller doesn't own is a 404,
803 /// never another user's assets. An existing, visible version with no
804 /// generated audio returns an empty manifest.
805 pub async fn flow_version_assets(
806 &self,
807 flow_id: &str,
808 version: u32,
809 ) -> Result<VoiceFlowAssetsPage> {
810 let path = format!("/api/voice/flows/{flow_id}/versions/{version}/assets");
811 self.get_json::<VoiceFlowAssetsPage>(&path).await
812 }
813
814 /// `GET /api/voice/flows/{id}/versions/{version}/assets/{ref}/bytes` —
815 /// the immutable frozen copy of one clip, served from the version's own
816 /// asset set (never the mutable library). Returned in memory because a
817 /// clip is tens of KB and the daemon writes it atomically into its
818 /// on-disk cache; same flow-scoped 404 as the manifest.
819 pub async fn flow_version_asset_bytes(
820 &self,
821 flow_id: &str,
822 version: u32,
823 asset_ref: &str,
824 ) -> Result<Vec<u8>> {
825 let path =
826 format!("/api/voice/flows/{flow_id}/versions/{version}/assets/{asset_ref}/bytes");
827 self.get_bytes(&path).await
828 }
829
830 /// `GET /api/voice/flows/system?language=…&schema_versions=…` — the
831 /// curated system (ready-made) flow catalogue, tier-cut by language and
832 /// filterable by supported schema versions. Public by design — a
833 /// signed-out device lists and caches the catalogue. No bearer auth
834 /// on purpose; the endpoint is available before any sign-in.
835 ///
836 /// `language` is optional (the platform lists all when absent); pass
837 /// `None` to omit it. `schema_versions` is a comma-separated ascending
838 /// list (`"1,2"`) and is always sent — the platform reads silence as
839 /// "v1 only", same warning as [`VoiceFlowsQuery::schema_versions`].
840 pub async fn system_flows(
841 base_url: &str,
842 language: Option<&str>,
843 schema_versions: &str,
844 ) -> Result<VoiceSystemFlowsPage> {
845 let language_owned;
846 let mut query: Vec<(&str, &str)> = vec![("schema_versions", schema_versions)];
847 if let Some(lang) = language {
848 language_owned = lang.to_string();
849 query.push(("language", &language_owned));
850 }
851 Self::get_public_json::<VoiceSystemFlowsPage>(base_url, "/api/voice/flows/system", &query)
852 .await
853 }
854
855 /// `GET /api/voice/flows/system/{id}/versions/{version}/assets` — the
856 /// frozen audio manifest for one system flow version. Public by design.
857 /// Returns an empty manifest if the version has no generated audio.
858 ///
859 /// Reuses [`VoiceFlowAssetsPage`], which is the same wire shape as the
860 /// gated manifest for owned flows.
861 pub async fn system_flow_version_assets(
862 base_url: &str,
863 flow_id: &str,
864 version: u32,
865 ) -> Result<VoiceFlowAssetsPage> {
866 let path = format!("/api/voice/flows/system/{flow_id}/versions/{version}/assets");
867 Self::get_public_json::<VoiceFlowAssetsPage>(base_url, &path, &[]).await
868 }
869
870 /// `GET /api/voice/flows/system/{id}/versions/{version}/assets/{ref}/bytes`
871 /// — one clip from a
872 /// system flow's frozen asset set. Public by design — a signed-out
873 /// device fetches clips for offline preview and caching. Returned in
874 /// memory because a clip is tens of KB; same atomicity and offline-safe
875 /// guarantees as the gated owned-flow asset fetch.
876 pub async fn system_flow_version_asset_bytes(
877 base_url: &str,
878 flow_id: &str,
879 version: u32,
880 asset_ref: &str,
881 ) -> Result<Vec<u8>> {
882 let path = format!(
883 "/api/voice/flows/system/{flow_id}/versions/{version}/assets/{asset_ref}/bytes"
884 );
885 Self::get_public_bytes(base_url, &path).await
886 }
887}
888
889// ---- Booking (mid-call, synchronous) ---------------------------------------
890//
891// The action plane of wavekat-platform's docs/30: a `book` step asking
892// "when is this business free?" and then "put the caller in at this
893// time", with the caller on the line.
894//
895// Unlike every other endpoint in this file, these are **synchronous and
896// in-call**. Nothing here is queued, batched or retried: a person is
897// waiting, so the platform answers within seconds or answers
898// `unavailable`, and the flow takes its fallback exit. Callers should
899// give these a short timeout of their own and treat expiry the same way
900// they treat `unavailable`.
901//
902// The calendar credential never reaches this crate. The platform holds
903// the connection and answers in times and outcomes — which is what makes
904// booking a pair of platform calls rather than a Google client in every
905// daemon.
906//
907// Wire note: these routes use `snake_case` bodies, unlike the camelCase
908// sync resources above, so these types carry no `rename_all`.
909
910/// One open window in a business's week, `"HH:MM"` 24-hour local time —
911/// the same shape the flow document's `hours`/`book` steps carry.
912#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
913pub struct BookingTimeRange {
914 pub open: String,
915 pub close: String,
916}
917
918/// Open windows per weekday. A missing or empty day is closed.
919#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
920pub struct BookingSchedule {
921 #[serde(default, skip_serializing_if = "Vec::is_empty")]
922 pub mon: Vec<BookingTimeRange>,
923 #[serde(default, skip_serializing_if = "Vec::is_empty")]
924 pub tue: Vec<BookingTimeRange>,
925 #[serde(default, skip_serializing_if = "Vec::is_empty")]
926 pub wed: Vec<BookingTimeRange>,
927 #[serde(default, skip_serializing_if = "Vec::is_empty")]
928 pub thu: Vec<BookingTimeRange>,
929 #[serde(default, skip_serializing_if = "Vec::is_empty")]
930 pub fri: Vec<BookingTimeRange>,
931 #[serde(default, skip_serializing_if = "Vec::is_empty")]
932 pub sat: Vec<BookingTimeRange>,
933 #[serde(default, skip_serializing_if = "Vec::is_empty")]
934 pub sun: Vec<BookingTimeRange>,
935}
936
937/// A single-date override of the weekly schedule (a holiday, or special
938/// hours).
939#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
940pub struct BookingException {
941 /// `"YYYY-MM-DD"` in the schedule's own timezone.
942 pub date: String,
943 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
944 pub closed: bool,
945 #[serde(default, skip_serializing_if = "Vec::is_empty")]
946 pub ranges: Vec<BookingTimeRange>,
947}
948
949/// Body of `POST /api/voice/booking/slots`.
950///
951/// Everything except `source_id` comes straight off the flow document's
952/// `book` step; the platform holds no per-node configuration of its own.
953#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
954pub struct BookingSlotsRequest {
955 /// The call this offer belongs to (`voice_calls.source_id`). Slots
956 /// are held against it, which is what stops a caller being blocked
957 /// by their own offers — and what stops a second caller being
958 /// offered the same time.
959 pub source_id: String,
960 pub duration_mins: u32,
961 #[serde(default)]
962 pub buffer_mins: u32,
963 #[serde(default)]
964 pub lead_mins: u32,
965 #[serde(default)]
966 pub horizon_days: u32,
967 pub schedule: BookingSchedule,
968 /// IANA zone the schedule is written in.
969 pub timezone: String,
970 #[serde(default, skip_serializing_if = "Vec::is_empty")]
971 pub exceptions: Vec<BookingException>,
972 /// How many times to offer. The answer may be shorter, never longer.
973 pub limit: u32,
974}
975
976/// One offerable appointment, as absolute RFC 3339 instants.
977#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
978pub struct BookingSlot {
979 pub start: String,
980 pub end: String,
981}
982
983/// Answer to `POST /api/voice/booking/slots`.
984///
985/// `slots` empty is a real answer — the calendar is full, or the window
986/// closed — and not an error: the flow takes its no-slots exit.
987#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
988pub struct BookingSlotsResponse {
989 #[serde(default)]
990 pub slots: Vec<BookingSlot>,
991 /// The zone the times should be *spoken* in — the business's, echoed
992 /// back so the caller isn't told a time in the server's zone.
993 #[serde(default)]
994 pub timezone: String,
995 /// Set when the platform could not read the calendar at all
996 /// (`"unavailable"`); `slots` is then empty and the reason is for
997 /// logs, never for a caller.
998 #[serde(default, skip_serializing_if = "Option::is_none")]
999 pub status: Option<String>,
1000 #[serde(default, skip_serializing_if = "Option::is_none")]
1001 pub reason: Option<String>,
1002}
1003
1004/// Body of `POST /api/voice/booking/book`.
1005///
1006/// Idempotent on `source_id`: a retried request for a call that already
1007/// has an appointment answers `booked` with the existing event's start,
1008/// without touching the calendar. A timed-out request is therefore safe
1009/// to repeat.
1010#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1011pub struct BookingBookRequest {
1012 pub source_id: String,
1013 /// One of the `start`s `/slots` handed back, verbatim.
1014 pub start: String,
1015 pub duration_mins: u32,
1016 pub timezone: String,
1017 /// Who is booking, for the calendar entry. Empty when the call
1018 /// carried no caller id.
1019 #[serde(default)]
1020 pub caller_number: String,
1021 #[serde(default, skip_serializing_if = "Option::is_none")]
1022 pub caller_name: Option<String>,
1023}
1024
1025/// Answer to `POST /api/voice/booking/book`.
1026///
1027/// Three outcomes, and the flow does something different with each:
1028/// `booked` continues, `slot_taken` can offer again, `unavailable` falls
1029/// back. Left as a string rather than an enum so a status added later
1030/// deserializes instead of failing the call.
1031#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1032pub struct BookingBookResponse {
1033 pub status: String,
1034 /// Present on `booked` — the instant the appointment actually
1035 /// starts, which on an idempotent retry is the *existing* event's
1036 /// start and not necessarily the one that was asked for.
1037 #[serde(default, skip_serializing_if = "Option::is_none")]
1038 pub start: Option<String>,
1039 #[serde(default, skip_serializing_if = "Option::is_none")]
1040 pub reason: Option<String>,
1041}
1042
1043impl Client {
1044 /// `POST /api/voice/booking/slots` — when is this business free?
1045 ///
1046 /// Writes as well as reads: every time it returns is held for
1047 /// `source_id` for a couple of minutes, so a second caller is not
1048 /// offered it while this one is still deciding. Re-offering the same
1049 /// call refreshes its own holds rather than colliding with them.
1050 pub async fn booking_slots(
1051 &self,
1052 request: &BookingSlotsRequest,
1053 ) -> Result<BookingSlotsResponse> {
1054 self.post_json::<BookingSlotsResponse, _>("/api/voice/booking/slots", request)
1055 .await
1056 }
1057
1058 /// `POST /api/voice/booking/book` — put the caller in at this time.
1059 pub async fn booking_book(&self, request: &BookingBookRequest) -> Result<BookingBookResponse> {
1060 self.post_json::<BookingBookResponse, _>("/api/voice/booking/book", request)
1061 .await
1062 }
1063}
1064
1065// ---- Anonymous install heartbeat ------------------------------------------
1066//
1067// A first-run / per-launch ping the desktop daemon fires *before* (and
1068// independently of) any platform sign-in, so the platform can count
1069// installs and track version / OS adoption for users who never sign in.
1070// It hits the public, unauthenticated `POST /api/voice/installs/heartbeat`
1071// and upserts a row keyed by `install_id` alone (no user) — distinct
1072// from the authenticated `voice_clients` heartbeat, which is keyed by
1073// `(user, install_id)`.
1074//
1075// The environment fields (os / os_version / arch / locale) are gathered
1076// *here*, inside the client crate, rather than on the consumer side:
1077// the daemon only owns the two values this crate genuinely cannot
1078// discover — the persisted `install_id` and its own app version.
1079
1080/// Best-effort snapshot of the host environment, detected at call time.
1081/// Every field is best-effort; a probe that fails contributes `None`
1082/// (or, for the always-available `os` / `arch`, the compile-time
1083/// target) rather than failing the heartbeat.
1084#[derive(Debug, Clone, PartialEq, Eq)]
1085pub struct SystemInfo {
1086 /// `std::env::consts::OS` — `"macos"`, `"windows"`, `"linux"`, …
1087 pub os: String,
1088 /// Human OS version, e.g. `"15.5.0"`. `None` when the OS probe
1089 /// can't determine it.
1090 pub os_version: Option<String>,
1091 /// `std::env::consts::ARCH` — `"aarch64"`, `"x86_64"`, …
1092 pub arch: String,
1093 /// BCP-47 system locale, e.g. `"en-NZ"`. `None` when unset /
1094 /// undetectable (common for GUI-launched apps on some platforms).
1095 pub locale: Option<String>,
1096}
1097
1098impl SystemInfo {
1099 /// Probe the current host. Cheap enough to call per heartbeat; we
1100 /// don't cache so a locale change between launches is reflected.
1101 pub fn detect() -> Self {
1102 let os_version = match os_info::get().version() {
1103 os_info::Version::Unknown => None,
1104 v => Some(v.to_string()),
1105 };
1106 SystemInfo {
1107 os: std::env::consts::OS.to_string(),
1108 os_version,
1109 arch: std::env::consts::ARCH.to_string(),
1110 locale: sys_locale::get_locale(),
1111 }
1112 }
1113}
1114
1115/// Body of `POST /api/voice/installs/heartbeat`. The daemon supplies
1116/// `install_id` + `app_version`; [`Client::install_heartbeat`] fills the
1117/// environment fields from [`SystemInfo::detect`].
1118#[derive(Debug, Clone, Serialize, Deserialize)]
1119#[serde(rename_all = "camelCase")]
1120pub struct InstallHeartbeatRequest {
1121 /// The daemon's persisted install UUID — the platform's upsert key.
1122 pub install_id: String,
1123 /// WaveKat Voice's own version (`env!("CARGO_PKG_VERSION")` on the
1124 /// daemon side) — *not* this crate's version.
1125 pub app_version: String,
1126 pub os: String,
1127 #[serde(default, skip_serializing_if = "Option::is_none")]
1128 pub os_version: Option<String>,
1129 #[serde(default, skip_serializing_if = "Option::is_none")]
1130 pub arch: Option<String>,
1131 #[serde(default, skip_serializing_if = "Option::is_none")]
1132 pub locale: Option<String>,
1133 /// How this copy was obtained — `"direct"` for a plain download,
1134 /// `"mas"` for the sandboxed Mac App Store build. Unlike every other
1135 /// field here it is **not** detectable: the two macOS builds share a
1136 /// bundle id and a version, and the binary is identical, so only the
1137 /// consumer knows which one it is shipping inside. Hence a caller
1138 /// argument rather than part of [`SystemInfo`].
1139 ///
1140 /// Free text by contract, not an enum: the platform stores whatever
1141 /// arrives so a new distribution can ship without a server release.
1142 /// `None` when the consumer has nothing meaningful to say (a source
1143 /// build, a package this crate has never heard of) — omitted from
1144 /// the body entirely rather than sent as null.
1145 #[serde(default, skip_serializing_if = "Option::is_none")]
1146 pub distribution: Option<String>,
1147}
1148
1149/// The platform's view of an install row, echoed back from a heartbeat.
1150#[derive(Debug, Clone, Serialize, Deserialize)]
1151#[serde(rename_all = "camelCase")]
1152pub struct InstallHeartbeatResponse {
1153 pub id: String,
1154 pub install_id: String,
1155 pub app_version: String,
1156 pub os: String,
1157 pub os_version: Option<String>,
1158 pub arch: Option<String>,
1159 pub locale: Option<String>,
1160 /// Echoed back. `#[serde(default)]` because a platform deployed
1161 /// before this field existed omits the key rather than sending null,
1162 /// and a heartbeat must not fail to parse against an older server.
1163 #[serde(default)]
1164 pub distribution: Option<String>,
1165 pub first_seen_at: String,
1166 pub last_seen_at: String,
1167}
1168
1169impl Client {
1170 /// `POST /api/voice/installs/heartbeat` — the anonymous, no-auth
1171 /// first-run install ping. Detects the host environment internally
1172 /// and posts it alongside the caller-supplied `install_id` +
1173 /// `app_version`. Associated (not a method) because the endpoint is
1174 /// unauthenticated — there's no token, and at first run there's no
1175 /// signed-in `Client` to hang it off of.
1176 ///
1177 /// Though unauthenticated, the request is **signed** with the release
1178 /// credential `cred` (a per-version Ed25519 key + master-issued
1179 /// certificate the consumer bakes in at build time) so the platform
1180 /// can verify it came from a genuine release and reject forged or
1181 /// replayed pings — see [`Client::post_public_signed_json`] and
1182 /// [`crate::sign`]. The platform needs only the master *public* key to
1183 /// verify.
1184 ///
1185 /// `base_url` is the platform base (e.g. `https://platform.wavekat.com`).
1186 ///
1187 /// `distribution` says how this copy was obtained (`"direct"`,
1188 /// `"mas"`, …). It is the one field this call can't detect for
1189 /// itself — see [`InstallHeartbeatRequest::distribution`] — so pass
1190 /// `None` if the consumer has nothing meaningful to say.
1191 pub async fn install_heartbeat(
1192 base_url: &str,
1193 install_id: &str,
1194 app_version: &str,
1195 distribution: Option<&str>,
1196 cred: &ReleaseCredential,
1197 ) -> Result<InstallHeartbeatResponse> {
1198 let sys = SystemInfo::detect();
1199 let body = InstallHeartbeatRequest {
1200 install_id: install_id.to_string(),
1201 app_version: app_version.to_string(),
1202 os: sys.os,
1203 os_version: sys.os_version,
1204 arch: Some(sys.arch),
1205 locale: sys.locale,
1206 distribution: distribution.map(str::to_string),
1207 };
1208 Client::post_public_signed_json::<InstallHeartbeatResponse, _>(
1209 base_url,
1210 "/api/voice/installs/heartbeat",
1211 &body,
1212 cred,
1213 )
1214 .await
1215 }
1216}
1217
1218// ---- Client surface for recordings ----------------------------------------
1219//
1220// Recordings don't fit the generic `Client::sync` shape cleanly:
1221//
1222// - the response carries per-item provenance (the platform-stamped
1223// `r2Key`, plus whether bytes have already landed) that the
1224// daemon needs in order to decide which rows still owe a PUT;
1225// - the bytes upload is its own HTTP call (`PUT
1226// /api/voice/recordings/{sourceId}/bytes`), not a JSON batch.
1227//
1228// Rather than overloading `SyncEndpoint` to carry these shapes, we
1229// expose two inherent methods on `Client` that compose the existing
1230// JSON / bytes-PUT primitives.
1231
1232impl Client {
1233 /// `POST /api/voice/recordings/sync` — idempotent batch upsert of
1234 /// recording metadata. Returns the per-item `r2Key` the daemon
1235 /// should target for the follow-up bytes PUT, and whether bytes
1236 /// have already landed for each row.
1237 ///
1238 /// Batch sizing rules match [`Client::sync`]: the platform rejects
1239 /// batches over 100 items; the daemon's uploader chunks at 50.
1240 pub async fn sync_recordings(
1241 &self,
1242 items: &[VoiceRecordingRecord],
1243 ) -> Result<VoiceRecordingsSyncResponse> {
1244 let stamped = stamp_schema_version::<VoiceRecordings>(items);
1245 let body = SyncRequest { items: stamped };
1246 self.post_json::<VoiceRecordingsSyncResponse, _>("/api/voice/recordings/sync", &body)
1247 .await
1248 }
1249
1250 /// `PUT /api/voice/recordings/{sourceId}/bytes` — upload the WAV
1251 /// bytes for a recording whose metadata was previously synced via
1252 /// [`Client::sync_recordings`]. The platform refuses (`HTTP 413`)
1253 /// if `bytes.len()` disagrees with the synced `sizeBytes`.
1254 ///
1255 /// `source_id` is path-segmented as-is; callers pass the
1256 /// daemon-side UUID they used for the metadata sync. Empty /
1257 /// path-traversal-shaped ids are not specifically guarded here —
1258 /// the platform's Zod schema rejects them server-side, so a
1259 /// malformed id surfaces as a 4xx via [`Error::Http`].
1260 pub async fn upload_recording_bytes(&self, source_id: &str, bytes: Vec<u8>) -> Result<()> {
1261 if source_id.is_empty() {
1262 return Err(Error::BadRequest("source_id must not be empty".into()));
1263 }
1264 let path = format!("/api/voice/recordings/{source_id}/bytes");
1265 self.put_raw_bytes(&path, "audio/wav", bytes).await
1266 }
1267}
1268
1269// ---- Recording sharing ----------------------------------------------------
1270//
1271// Sharing is a *command* — mutate one recording's share state and get a
1272// result back — not the "batch upsert + cursor list" shape `SyncEndpoint`
1273// exists for (see wavekat-voice doc 38). So it's a typed method pair on
1274// `Client` (mirroring `whoami` rather than `sync::<E>()`), not a marker.
1275//
1276// The desktop daemon keeps only a *mirror* of what these return; the
1277// platform is authoritative for who may open a share. See
1278// `wavekat-voice/docs/38-share-a-recording.md`.
1279
1280/// Access tier for a shared recording, mirroring Loom's model. Wire-stable
1281/// snake_case strings — the platform's Zod schema validates against this
1282/// exact list, so a rename here would bounce every share command with a 400.
1283///
1284/// - `Private` — owner only (the default; "not shared").
1285/// - `Restricted` — owner + explicitly invited WaveKat accounts; the
1286/// recipient must be signed in as an invited identity ("protected by login").
1287/// - `Public` — anyone holding the capability link, no sign-in.
1288#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1289#[serde(rename_all = "snake_case")]
1290pub enum ShareVisibility {
1291 Private,
1292 Restricted,
1293 Public,
1294}
1295
1296/// How a shared recording's caller/callee identity (the call's `party`) is
1297/// exposed to a viewer. Wire-stable snake_case, matching the platform's Zod
1298/// enum, so a rename here bounces a share command with a 400.
1299///
1300/// - `Full` — hidden behind a neutral direction label ("Inbound call").
1301/// - `Partial` — best-effort redaction (keeps shape, drops the value).
1302/// - `None` — the raw `party` is shown.
1303///
1304/// Absent on the wire → the platform defaults to `Partial` (identity
1305/// masked) — privacy-forward without fully erasing the caller. See
1306/// `wavekat-platform` docs/14.
1307#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1308#[serde(rename_all = "snake_case")]
1309pub enum PartyMasking {
1310 Full,
1311 Partial,
1312 None,
1313}
1314
1315/// Body of `POST /api/voice/recordings/{id}/share` — create or update a
1316/// recording's share. The recording must already be synced (metadata +
1317/// bytes) or the platform returns 404.
1318#[derive(Debug, Clone, Serialize, Deserialize)]
1319#[serde(rename_all = "camelCase")]
1320pub struct ShareRecordingRequest {
1321 /// The artifact UUID, as synced (daemon-side `artifacts.id`). Goes in
1322 /// the URL path; carried in the struct so callers pass one value.
1323 pub recording_source_id: String,
1324 pub visibility: ShareVisibility,
1325 /// Restricted tier — the WaveKat-account emails allowed to open the
1326 /// share. Ignored (and omitted) for `Private` / `Public`.
1327 #[serde(default, skip_serializing_if = "Option::is_none")]
1328 pub invited_emails: Option<Vec<String>>,
1329 /// Per-share visibility controls (platform docs/14) — what a viewer may
1330 /// see. Each is omitted when unset; the platform then applies its
1331 /// privacy-forward default (identity masked, transcript hidden, audio
1332 /// shown, download off). NB the platform treats the request as the
1333 /// *full* desired state, so an omitted control is reset to its default,
1334 /// not preserved from a prior share — send all of them when editing an
1335 /// existing share's controls.
1336 #[serde(default, skip_serializing_if = "Option::is_none")]
1337 pub party_masking: Option<PartyMasking>,
1338 #[serde(default, skip_serializing_if = "Option::is_none")]
1339 pub show_transcript: Option<bool>,
1340 #[serde(default, skip_serializing_if = "Option::is_none")]
1341 pub show_audio: Option<bool>,
1342 /// Whether a viewer may *download* the WAV, distinct from hearing it.
1343 /// Off by default and only meaningful while `show_audio` is true — the
1344 /// platform forces it off otherwise (you can't save what you can't
1345 /// hear). A soft control: it hides the viewer's Download affordance,
1346 /// not the bytes a listener already fetches to play.
1347 #[serde(default, skip_serializing_if = "Option::is_none")]
1348 pub allow_download: Option<bool>,
1349 /// Per-channel playback defaults — which side is *audible by default*
1350 /// in the viewer's player (docs/14). A call has two channels: `local`
1351 /// (the owner's microphone, "your side") and `remote` (the other
1352 /// party, "their side"). `true` means that side starts muted; the
1353 /// viewer can still un-mute it, and the audio file is unchanged — this
1354 /// is only the player's starting state. Each is omitted when unset, in
1355 /// which case the platform defaults to audible (`false`). Only
1356 /// meaningful while `show_audio` is true; ignored when audio is hidden.
1357 #[serde(default, skip_serializing_if = "Option::is_none")]
1358 pub default_mute_local: Option<bool>,
1359 #[serde(default, skip_serializing_if = "Option::is_none")]
1360 pub default_mute_remote: Option<bool>,
1361 /// Phase 2 — out-of-band password gate. Omitted when unset.
1362 #[serde(default, skip_serializing_if = "Option::is_none")]
1363 pub password: Option<String>,
1364 /// Phase 2 — RFC 3339 auto-revoke time. Omitted when unset.
1365 #[serde(default, skip_serializing_if = "Option::is_none")]
1366 pub expires_at: Option<String>,
1367}
1368
1369/// The platform's response to a successful share command. `share_url` is
1370/// the full https link the user copies; `token` is the opaque capability
1371/// identifier embedded in it (returned separately so the daemon can store
1372/// it for display without re-parsing the URL).
1373#[derive(Debug, Clone, Serialize, Deserialize)]
1374#[serde(rename_all = "camelCase")]
1375pub struct ShareRecordingResponse {
1376 pub visibility: ShareVisibility,
1377 pub token: String,
1378 pub share_url: String,
1379 /// RFC 3339 — when the recording was first shared.
1380 pub shared_at: String,
1381 /// Effective visibility controls the platform stored (docs/14). Optional
1382 /// for tolerance — a platform predating the feature omits them, in which
1383 /// case the daemon should assume the defaults (identity masked, transcript
1384 /// hidden, audio shown, download off).
1385 #[serde(default, skip_serializing_if = "Option::is_none")]
1386 pub party_masking: Option<PartyMasking>,
1387 #[serde(default, skip_serializing_if = "Option::is_none")]
1388 pub show_transcript: Option<bool>,
1389 #[serde(default, skip_serializing_if = "Option::is_none")]
1390 pub show_audio: Option<bool>,
1391 /// Effective download permission — `show_audio && allow_download`, so
1392 /// it's never true when the audio is hidden. Absent on a platform
1393 /// predating the control (assume off).
1394 #[serde(default, skip_serializing_if = "Option::is_none")]
1395 pub allow_download: Option<bool>,
1396 /// Effective per-channel playback defaults the platform stored — which
1397 /// side starts muted in the viewer's player (docs/14). Absent on a
1398 /// platform predating the control (assume audible, `false`).
1399 #[serde(default, skip_serializing_if = "Option::is_none")]
1400 pub default_mute_local: Option<bool>,
1401 #[serde(default, skip_serializing_if = "Option::is_none")]
1402 pub default_mute_remote: Option<bool>,
1403}
1404
1405/// The platform's response to `GET /api/voice/recordings/{id}/share` — the
1406/// *authoritative* current share state for an owned recording. The POST
1407/// reply omits the invited-email list and a local mirror can't reflect a
1408/// share changed from another device, so the desktop "who can open this"
1409/// panel reads here.
1410///
1411/// A recording that was never shared (or whose share is revoked / expired)
1412/// comes back as [`ShareVisibility::Private`] with the optional fields
1413/// absent — the same "not shared" state DELETE leaves behind.
1414#[derive(Debug, Clone, Serialize, Deserialize)]
1415#[serde(rename_all = "camelCase")]
1416pub struct ShareStateResponse {
1417 pub visibility: ShareVisibility,
1418 /// Absent when `visibility == Private` (nothing is shared).
1419 #[serde(default, skip_serializing_if = "Option::is_none")]
1420 pub token: Option<String>,
1421 #[serde(default, skip_serializing_if = "Option::is_none")]
1422 pub share_url: Option<String>,
1423 /// RFC 3339 — when the recording was first shared. Absent when private.
1424 #[serde(default, skip_serializing_if = "Option::is_none")]
1425 pub shared_at: Option<String>,
1426 /// The restricted tier's audience (lowercased, de-duped). Present
1427 /// (possibly empty) only for [`ShareVisibility::Restricted`].
1428 #[serde(default, skip_serializing_if = "Option::is_none")]
1429 pub invited_emails: Option<Vec<String>>,
1430 /// Per-share visibility controls (docs/14). Present for a live share;
1431 /// absent when `Private` (nothing is shared, so no controls apply).
1432 #[serde(default, skip_serializing_if = "Option::is_none")]
1433 pub party_masking: Option<PartyMasking>,
1434 #[serde(default, skip_serializing_if = "Option::is_none")]
1435 pub show_transcript: Option<bool>,
1436 #[serde(default, skip_serializing_if = "Option::is_none")]
1437 pub show_audio: Option<bool>,
1438 /// Effective download permission — `show_audio && allow_download`, so
1439 /// never true when the audio is hidden. Absent when private.
1440 #[serde(default, skip_serializing_if = "Option::is_none")]
1441 pub allow_download: Option<bool>,
1442 /// Effective per-channel playback defaults — which side starts muted in
1443 /// the viewer's player (docs/14). Absent when private.
1444 #[serde(default, skip_serializing_if = "Option::is_none")]
1445 pub default_mute_local: Option<bool>,
1446 #[serde(default, skip_serializing_if = "Option::is_none")]
1447 pub default_mute_remote: Option<bool>,
1448}
1449
1450impl Client {
1451 /// `POST /api/voice/recordings/{id}/share` — create or update a share
1452 /// for an already-synced recording. Returns the capability link + token
1453 /// the desktop UI puts on the clipboard.
1454 ///
1455 /// Per the 404-not-403 ownership rule (doc 21 §"Authorization"), asking
1456 /// to share a recording the caller doesn't own surfaces as
1457 /// [`Error::Http`] with status 404 — existence doesn't leak.
1458 pub async fn share_recording(
1459 &self,
1460 req: &ShareRecordingRequest,
1461 ) -> Result<ShareRecordingResponse> {
1462 if req.recording_source_id.is_empty() {
1463 return Err(Error::BadRequest(
1464 "recording_source_id must not be empty".into(),
1465 ));
1466 }
1467 let path = format!("/api/voice/recordings/{}/share", req.recording_source_id);
1468 self.post_json::<ShareRecordingResponse, _>(&path, req)
1469 .await
1470 }
1471
1472 /// `GET /api/voice/recordings/{id}/share` — read the authoritative
1473 /// share state for an owned recording, including the restricted tier's
1474 /// invited emails (which the share command's reply omits). Like
1475 /// [`share_recording`](Self::share_recording), a recording the caller
1476 /// doesn't own surfaces as [`Error::Http`] with status 404.
1477 pub async fn get_recording_share(
1478 &self,
1479 recording_source_id: &str,
1480 ) -> Result<ShareStateResponse> {
1481 if recording_source_id.is_empty() {
1482 return Err(Error::BadRequest(
1483 "recording_source_id must not be empty".into(),
1484 ));
1485 }
1486 let path = format!("/api/voice/recordings/{recording_source_id}/share");
1487 self.get_json::<ShareStateResponse>(&path).await
1488 }
1489
1490 /// `DELETE /api/voice/recordings/{id}/share` — revoke the share. The
1491 /// recording reverts to Private and any outstanding link returns 410.
1492 pub async fn revoke_recording_share(&self, recording_source_id: &str) -> Result<()> {
1493 if recording_source_id.is_empty() {
1494 return Err(Error::BadRequest(
1495 "recording_source_id must not be empty".into(),
1496 ));
1497 }
1498 let path = format!("/api/voice/recordings/{recording_source_id}/share");
1499 self.delete(&path).await
1500 }
1501}
1502
1503#[cfg(test)]
1504mod tests {
1505 use super::*;
1506
1507 #[test]
1508 fn share_visibility_types_are_reachable_from_the_crate_root() {
1509 // Regression for the 0.0.13 gap: `PartyMasking` was added to this
1510 // module but left out of the crate-root `pub use voice::{…}`, and the
1511 // module is private — so a consumer (`wavekat-voice`) couldn't name
1512 // the type to build a `ShareRecordingRequest`. Pin every share-control
1513 // type to the root path so dropping one fails to compile here, not in
1514 // a downstream crate. The body never runs; reachability is the test.
1515 #[allow(dead_code)]
1516 fn _reachable() {
1517 let _: Option<crate::PartyMasking> = Some(crate::PartyMasking::Partial);
1518 let _: Option<crate::ShareVisibility> = Some(crate::ShareVisibility::Public);
1519 let _: fn(&crate::ShareRecordingRequest) = |_| {};
1520 let _: fn(&crate::ShareRecordingResponse) = |_| {};
1521 }
1522 }
1523
1524 #[test]
1525 fn record_serializes_with_camel_case_keys() {
1526 let r = VoiceCallRecord {
1527 source_id: "11111111-1111-4111-8111-111111111111".into(),
1528 account_id: "22222222-2222-4222-8222-222222222222".into(),
1529 direction: VoiceCallDirection::Inbound,
1530 party: "+14155550123".into(),
1531 ring_at: "2026-05-16T10:00:00Z".into(),
1532 answer_at: Some("2026-05-16T10:00:05Z".into()),
1533 end_at: "2026-05-16T10:01:00Z".into(),
1534 duration_ms: Some(55_000),
1535 disposition: VoiceCallDisposition::Answered,
1536 end_reason: VoiceCallEndReason::HangupRemote,
1537 error: None,
1538 share_visibility: None,
1539 transfer_target: None,
1540 codec: None,
1541 flow_id: None,
1542 flow_name: None,
1543 flow_outcome: None,
1544 flow_steps: None,
1545 deleted_at: None,
1546 envelope: SyncEnvelope::for_endpoint::<VoiceCalls>(),
1547 };
1548 let s = serde_json::to_string(&r).unwrap();
1549 assert!(s.contains("\"sourceId\":"), "{s}");
1550 assert!(s.contains("\"accountId\":"), "{s}");
1551 assert!(s.contains("\"ringAt\":"), "{s}");
1552 assert!(s.contains("\"endAt\":"), "{s}");
1553 assert!(s.contains("\"durationMs\":55000"), "{s}");
1554 // Optional `error` is None — should be omitted from the wire.
1555 assert!(!s.contains("\"error\""), "error should be omitted: {s}");
1556 // Optional `transferTarget` is None here — omitted from the wire,
1557 // exactly like a non-transferred call ships.
1558 assert!(
1559 !s.contains("\"transferTarget\""),
1560 "transferTarget should be omitted: {s}"
1561 );
1562 // Optional `codec` is None (never-answered call, or an older
1563 // daemon) — omitted from the wire, never `null`.
1564 assert!(!s.contains("\"codec\""), "codec should be omitted: {s}");
1565 // Envelope flattens to the top of the object — schemaVersion
1566 // sits next to the other fields rather than nested under
1567 // "envelope". Future resources rely on this layout.
1568 assert!(
1569 s.contains("\"schemaVersion\":1"),
1570 "schemaVersion should flatten: {s}"
1571 );
1572 // `extras` is None, so the envelope contributes no `extras`
1573 // key. Stays out of the row to keep the small/fast path.
1574 assert!(!s.contains("\"extras\""), "extras should be omitted: {s}");
1575 // A live call omits the tombstone entirely rather than sending
1576 // `null` — every ordinary sync is a live call, so this is the
1577 // common path and it should stay off the wire.
1578 assert!(
1579 !s.contains("\"deletedAt\""),
1580 "deletedAt should be omitted on a live call: {s}"
1581 );
1582 }
1583
1584 #[test]
1585 fn call_tombstone_serializes_deleted_at() {
1586 // The delete-propagation mechanism: a deleted call rides up as
1587 // an ordinary upsert with `deletedAt` set (platform docs/22),
1588 // the same shape the account tombstone uses.
1589 let mut r = VoiceCallRecord {
1590 source_id: "11111111-1111-4111-8111-111111111111".into(),
1591 account_id: "22222222-2222-4222-8222-222222222222".into(),
1592 direction: VoiceCallDirection::Inbound,
1593 party: "+14155550123".into(),
1594 ring_at: "2026-05-16T10:00:00Z".into(),
1595 answer_at: None,
1596 end_at: "2026-05-16T10:01:00Z".into(),
1597 duration_ms: None,
1598 disposition: VoiceCallDisposition::Missed,
1599 end_reason: VoiceCallEndReason::HangupRemote,
1600 error: None,
1601 share_visibility: None,
1602 transfer_target: None,
1603 codec: None,
1604 flow_id: None,
1605 flow_name: None,
1606 flow_outcome: None,
1607 flow_steps: None,
1608 deleted_at: None,
1609 envelope: SyncEnvelope::for_endpoint::<VoiceCalls>(),
1610 };
1611 r.deleted_at = Some("2026-07-30T12:00:00Z".into());
1612 let s = serde_json::to_string(&r).unwrap();
1613 assert!(s.contains("\"deletedAt\":\"2026-07-30T12:00:00Z\""), "{s}");
1614 }
1615
1616 #[test]
1617 fn call_record_parses_without_deleted_at() {
1618 // Reading back a live call from `GET /api/voice/calls`: the
1619 // platform sends `deletedAt: null`, and a platform build
1620 // predating the field sends nothing at all. Both must land as
1621 // `None` rather than failing the whole page.
1622 let raw = r#"{
1623 "sourceId": "a",
1624 "accountId": "b",
1625 "direction": "outbound",
1626 "party": "+14155550123",
1627 "ringAt": "2026-05-16T10:00:00Z",
1628 "endAt": "2026-05-16T10:01:00Z",
1629 "disposition": "answered",
1630 "endReason": "hangup_local"
1631 }"#;
1632 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1633 assert!(parsed.deleted_at.is_none());
1634
1635 let with_null: VoiceCallRecord =
1636 serde_json::from_str(&raw.replace('}', r#", "deletedAt": null }"#)).unwrap();
1637 assert!(with_null.deleted_at.is_none());
1638 }
1639
1640 #[test]
1641 fn calls_query_serializes_include_deleted() {
1642 // The delta-pull flag a device sets to learn about deletes made
1643 // elsewhere. Omitted when unset, so an ordinary list request is
1644 // unchanged.
1645 let live = VoiceCallsQuery::default();
1646 assert_eq!(serde_json::to_string(&live).unwrap(), "{}");
1647
1648 let delta = VoiceCallsQuery {
1649 include_deleted: Some(true),
1650 ..Default::default()
1651 };
1652 let s = serde_json::to_string(&delta).unwrap();
1653 assert!(s.contains("\"includeDeleted\":true"), "{s}");
1654 }
1655
1656 #[test]
1657 fn record_round_trips_optional_fields() {
1658 // An unanswered call has answer_at/duration_ms/error all absent.
1659 let raw = r#"{
1660 "sourceId": "a",
1661 "accountId": "b",
1662 "direction": "inbound",
1663 "party": "anonymous",
1664 "ringAt": "2026-05-16T10:00:00Z",
1665 "endAt": "2026-05-16T10:00:30Z",
1666 "disposition": "missed",
1667 "endReason": "missed"
1668 }"#;
1669 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1670 assert!(parsed.answer_at.is_none());
1671 assert!(parsed.duration_ms.is_none());
1672 assert!(parsed.error.is_none());
1673 assert_eq!(parsed.disposition, VoiceCallDisposition::Missed);
1674 assert_eq!(parsed.end_reason, VoiceCallEndReason::Missed);
1675 }
1676
1677 #[test]
1678 fn query_omits_unset_fields() {
1679 let q = VoiceCallsQuery::default();
1680 let s = serde_json::to_string(&q).unwrap();
1681 // Empty object — every field skipped when None.
1682 assert_eq!(
1683 s, "{}",
1684 "default query should serialize to empty object: {s}"
1685 );
1686 }
1687
1688 #[test]
1689 fn enum_round_trip_via_json() {
1690 // The wire form for each direction/disposition/reason must
1691 // match what the daemon and platform expect — this guards
1692 // against accidental Rust-side renames.
1693 for d in [VoiceCallDirection::Inbound, VoiceCallDirection::Outbound] {
1694 let s = serde_json::to_string(&d).unwrap();
1695 let back: VoiceCallDirection = serde_json::from_str(&s).unwrap();
1696 assert_eq!(d, back);
1697 }
1698 for d in [
1699 VoiceCallDisposition::Answered,
1700 VoiceCallDisposition::Missed,
1701 VoiceCallDisposition::Rejected,
1702 VoiceCallDisposition::Cancelled,
1703 VoiceCallDisposition::Failed,
1704 ] {
1705 let s = serde_json::to_string(&d).unwrap();
1706 let back: VoiceCallDisposition = serde_json::from_str(&s).unwrap();
1707 assert_eq!(d, back);
1708 }
1709 for r in [
1710 VoiceCallEndReason::HangupLocal,
1711 VoiceCallEndReason::HangupRemote,
1712 VoiceCallEndReason::RejectedLocal,
1713 VoiceCallEndReason::RejectedRemote,
1714 VoiceCallEndReason::Missed,
1715 VoiceCallEndReason::CancelledLocal,
1716 VoiceCallEndReason::TransferredLocal,
1717 VoiceCallEndReason::ConnectionLost,
1718 VoiceCallEndReason::Failed,
1719 ] {
1720 let s = serde_json::to_string(&r).unwrap();
1721 let back: VoiceCallEndReason = serde_json::from_str(&s).unwrap();
1722 assert_eq!(r, back);
1723 }
1724 }
1725
1726 #[test]
1727 fn connection_lost_pins_its_wire_string() {
1728 // The platform's sync endpoint validates end reasons against
1729 // an exact string list — a rename here would make every
1730 // upload from a session-timer teardown bounce with a 400.
1731 let s = serde_json::to_string(&VoiceCallEndReason::ConnectionLost).unwrap();
1732 assert_eq!(s, "\"connection_lost\"");
1733 }
1734
1735 #[test]
1736 fn transferred_local_pins_its_wire_string() {
1737 // Same contract as `connection_lost`: the platform validates
1738 // against an exact string list, so a rename here would bounce
1739 // every transferred-call upload with a 400.
1740 let s = serde_json::to_string(&VoiceCallEndReason::TransferredLocal).unwrap();
1741 assert_eq!(s, "\"transferred_local\"");
1742 }
1743
1744 #[test]
1745 fn record_round_trips_transfer_target() {
1746 // A transferred call carries `transferTarget` both ways — the
1747 // daemon ships it (it's its own data, not read-only decoration),
1748 // and the platform echoes it back on read.
1749 let raw = r#"{
1750 "sourceId": "a",
1751 "accountId": "b",
1752 "direction": "inbound",
1753 "party": "Alice <sip:alice@example.com>",
1754 "ringAt": "2026-06-28T10:00:00Z",
1755 "answerAt": "2026-06-28T10:00:05Z",
1756 "endAt": "2026-06-28T10:00:30Z",
1757 "durationMs": 25000,
1758 "disposition": "answered",
1759 "endReason": "transferred_local",
1760 "transferTarget": "1002"
1761 }"#;
1762 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1763 assert_eq!(parsed.end_reason, VoiceCallEndReason::TransferredLocal);
1764 assert_eq!(parsed.transfer_target.as_deref(), Some("1002"));
1765 // And it survives a re-serialize (daemon → platform direction).
1766 let s = serde_json::to_string(&parsed).unwrap();
1767 assert!(s.contains("\"transferTarget\":\"1002\""), "{s}");
1768 }
1769
1770 #[test]
1771 fn codec_pins_its_wire_strings() {
1772 // The platform's sync endpoint validates the codec against an
1773 // exact string list, and the daemon's `CallCodec::as_str` emits
1774 // these same strings — a rename here would bounce every upload
1775 // from an answered call with a 400.
1776 for (codec, wire) in [
1777 (VoiceCallCodec::Opus, "\"opus\""),
1778 (VoiceCallCodec::Pcmu, "\"pcmu\""),
1779 (VoiceCallCodec::Pcma, "\"pcma\""),
1780 ] {
1781 assert_eq!(serde_json::to_string(&codec).unwrap(), wire);
1782 let back: VoiceCallCodec = serde_json::from_str(wire).unwrap();
1783 assert_eq!(back, codec);
1784 }
1785 }
1786
1787 #[test]
1788 fn record_round_trips_codec() {
1789 // An answered call carries `codec` both ways — the daemon ships
1790 // it (its own data, like transferTarget), and the platform
1791 // echoes it back on read so the website can show the call's
1792 // audio quality.
1793 let raw = r#"{
1794 "sourceId": "a",
1795 "accountId": "b",
1796 "direction": "inbound",
1797 "party": "Alice <sip:alice@example.com>",
1798 "ringAt": "2026-07-03T10:00:00Z",
1799 "answerAt": "2026-07-03T10:00:05Z",
1800 "endAt": "2026-07-03T10:00:30Z",
1801 "durationMs": 25000,
1802 "disposition": "answered",
1803 "endReason": "hangup_remote",
1804 "codec": "opus"
1805 }"#;
1806 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1807 assert_eq!(parsed.codec, Some(VoiceCallCodec::Opus));
1808 // And it survives a re-serialize (daemon → platform direction).
1809 let s = serde_json::to_string(&parsed).unwrap();
1810 assert!(s.contains("\"codec\":\"opus\""), "{s}");
1811
1812 // A row from an older daemon has no codec — reads as None.
1813 let legacy = raw.replace(",\n \"codec\": \"opus\"", "");
1814 let parsed: VoiceCallRecord = serde_json::from_str(&legacy).unwrap();
1815 assert_eq!(parsed.codec, None);
1816 }
1817
1818 #[test]
1819 fn flow_outcome_pins_its_wire_strings() {
1820 // Three parties agree on these exact strings: the daemon's
1821 // `flow_outcome_to_str`, `wavekat_flow::trace::FlowOutcome`'s
1822 // snake_case serde, and the platform's zod enum. A rename here
1823 // 400s every flow-answered call's batch.
1824 for (outcome, wire) in [
1825 (VoiceCallFlowOutcome::Answered, "\"answered\""),
1826 (VoiceCallFlowOutcome::MessageLeft, "\"message_left\""),
1827 (VoiceCallFlowOutcome::Transferred, "\"transferred\""),
1828 (VoiceCallFlowOutcome::HungUp, "\"hung_up\""),
1829 (VoiceCallFlowOutcome::Aborted, "\"aborted\""),
1830 (VoiceCallFlowOutcome::Defect, "\"defect\""),
1831 ] {
1832 assert_eq!(serde_json::to_string(&outcome).unwrap(), wire);
1833 let back: VoiceCallFlowOutcome = serde_json::from_str(wire).unwrap();
1834 assert_eq!(back, outcome);
1835 }
1836 }
1837
1838 #[test]
1839 fn record_round_trips_flow_attribution() {
1840 // A flow-answered call carries which flow took it and how the
1841 // run ended, both ways: the daemon ships them, the platform
1842 // echoes them so the website can say "Answered by “X”" and show
1843 // the run's own outcome instead of the misleading SIP one.
1844 let raw = r#"{
1845 "sourceId": "a",
1846 "accountId": "b",
1847 "direction": "inbound",
1848 "party": "Alice <sip:alice@example.com>",
1849 "ringAt": "2026-07-03T10:00:00Z",
1850 "answerAt": "2026-07-03T10:00:05Z",
1851 "endAt": "2026-07-03T10:00:30Z",
1852 "durationMs": 25000,
1853 "disposition": "answered",
1854 "endReason": "hangup_local",
1855 "flowId": "flow_after_hours",
1856 "flowName": "After hours",
1857 "flowOutcome": "message_left"
1858 }"#;
1859 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1860 assert_eq!(parsed.flow_id.as_deref(), Some("flow_after_hours"));
1861 assert_eq!(parsed.flow_name.as_deref(), Some("After hours"));
1862 assert_eq!(parsed.flow_outcome, Some(VoiceCallFlowOutcome::MessageLeft));
1863
1864 let s = serde_json::to_string(&parsed).unwrap();
1865 assert!(s.contains("\"flowId\":\"flow_after_hours\""), "{s}");
1866 assert!(s.contains("\"flowName\":\"After hours\""), "{s}");
1867 assert!(s.contains("\"flowOutcome\":\"message_left\""), "{s}");
1868 }
1869
1870 #[test]
1871 fn record_round_trips_a_flow_step_trace() {
1872 // Pins the per-step field names. These are consumed by the
1873 // platform's Zod schema on one side and produced by the daemon's
1874 // projection on the other; a silent rename here breaks both.
1875 let raw = r#"{
1876 "sourceId": "a",
1877 "accountId": "b",
1878 "direction": "inbound",
1879 "party": "sip:alice@example.com",
1880 "ringAt": "2026-07-03T10:00:00Z",
1881 "answerAt": "2026-07-03T10:00:05Z",
1882 "endAt": "2026-07-03T10:00:30Z",
1883 "disposition": "answered",
1884 "endReason": "hangup_local",
1885 "flowId": "f",
1886 "flowName": "F",
1887 "flowSteps": [
1888 { "atMs": 0, "kind": "spoke", "node": "greeting" },
1889 { "atMs": 4200, "kind": "menu_choice", "digit": "2" },
1890 { "atMs": 9100, "kind": "message_recorded", "secs": 31 }
1891 ]
1892 }"#;
1893 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1894 let steps = parsed.flow_steps.as_deref().expect("steps present");
1895 assert_eq!(steps.len(), 3);
1896 assert_eq!(steps[1].kind, "menu_choice");
1897 assert_eq!(steps[1].digit.as_deref(), Some("2"));
1898 assert_eq!(steps[2].secs, Some(31));
1899 // Absent per-step fields stay absent rather than serializing as
1900 // nulls — same contract as the record's own optional fields.
1901 let s = serde_json::to_string(&steps[0]).unwrap();
1902 assert_eq!(s, r#"{"atMs":0,"kind":"spoke","node":"greeting"}"#);
1903 }
1904
1905 #[test]
1906 fn flow_step_accepts_a_kind_this_build_does_not_know() {
1907 // The whole reason `kind` is a String. A consumer pinned to an
1908 // older crate version must still deserialize a newer daemon's
1909 // trace — rejecting would fail the entire call record, not one
1910 // step.
1911 let step: VoiceCallFlowStep =
1912 serde_json::from_str(r#"{"atMs": 10, "kind": "consulted_the_oracle"}"#).unwrap();
1913 assert_eq!(step.kind, "consulted_the_oracle");
1914 assert_eq!(step.digit, None);
1915 }
1916
1917 #[test]
1918 fn record_omits_flow_steps_for_a_human_answered_call() {
1919 // A call the user took themselves has no trace. The field must
1920 // stay off the wire entirely rather than serializing as null.
1921 let raw = r#"{
1922 "sourceId": "a",
1923 "accountId": "b",
1924 "direction": "inbound",
1925 "party": "sip:alice@example.com",
1926 "ringAt": "2026-07-03T10:00:00Z",
1927 "endAt": "2026-07-03T10:00:30Z",
1928 "disposition": "answered",
1929 "endReason": "hangup_local"
1930 }"#;
1931 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1932 assert!(parsed.flow_steps.is_none());
1933 let s = serde_json::to_string(&parsed).unwrap();
1934 assert!(!s.contains("flowSteps"), "{s}");
1935 }
1936
1937 #[test]
1938 fn record_omits_flow_fields_for_a_human_answered_call() {
1939 // Calls the user took themselves — and every row from a daemon
1940 // predating call flows — carry none of the three. They must
1941 // stay off the wire entirely, not serialize as nulls.
1942 let raw = r#"{
1943 "sourceId": "a",
1944 "accountId": "b",
1945 "direction": "inbound",
1946 "party": "sip:alice@example.com",
1947 "ringAt": "2026-07-03T10:00:00Z",
1948 "endAt": "2026-07-03T10:00:30Z",
1949 "disposition": "answered",
1950 "endReason": "hangup_remote"
1951 }"#;
1952 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1953 assert_eq!(parsed.flow_id, None);
1954 assert_eq!(parsed.flow_name, None);
1955 assert_eq!(parsed.flow_outcome, None);
1956
1957 let s = serde_json::to_string(&parsed).unwrap();
1958 assert!(!s.contains("\"flowId\""), "flowId should be omitted: {s}");
1959 assert!(
1960 !s.contains("\"flowName\""),
1961 "flowName should be omitted: {s}"
1962 );
1963 assert!(
1964 !s.contains("\"flowOutcome\""),
1965 "flowOutcome should be omitted: {s}"
1966 );
1967 }
1968
1969 #[test]
1970 fn voice_calls_marker_resource_is_calls() {
1971 assert_eq!(<VoiceCalls as SyncEndpoint>::RESOURCE, "calls");
1972 }
1973
1974 #[test]
1975 fn record_accepts_unknown_extras_for_forward_compat() {
1976 // A newer client shipping a `notes` field that this platform
1977 // version doesn't have a column for should round-trip via
1978 // the `extras` envelope. The platform persists the blob
1979 // verbatim; a future deploy can promote it to a typed
1980 // column without data loss.
1981 let raw = r#"{
1982 "sourceId": "a",
1983 "accountId": "b",
1984 "direction": "inbound",
1985 "party": "anon",
1986 "ringAt": "2026-05-16T10:00:00Z",
1987 "endAt": "2026-05-16T10:00:30Z",
1988 "disposition": "answered",
1989 "endReason": "hangup_remote",
1990 "schemaVersion": 2,
1991 "extras": { "notes": "from staging build" }
1992 }"#;
1993 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1994 assert_eq!(parsed.envelope.schema_version, Some(2));
1995 let extras = parsed.envelope.extras.as_ref().expect("extras present");
1996 assert_eq!(extras["notes"], "from staging build");
1997 }
1998
1999 #[test]
2000 fn call_record_parses_share_visibility_from_list_response() {
2001 // The list / detail endpoints decorate a call with the tier of any
2002 // active share on its recording, so a consumer can badge the row.
2003 let raw = r#"{
2004 "sourceId": "a",
2005 "accountId": "b",
2006 "direction": "outbound",
2007 "party": "+14155550123",
2008 "ringAt": "2026-05-16T10:00:00Z",
2009 "endAt": "2026-05-16T10:00:30Z",
2010 "disposition": "answered",
2011 "endReason": "hangup_remote",
2012 "shareVisibility": "public"
2013 }"#;
2014 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2015 assert_eq!(parsed.share_visibility, Some(ShareVisibility::Public));
2016
2017 let restricted = raw.replace("public", "restricted");
2018 let parsed: VoiceCallRecord = serde_json::from_str(&restricted).unwrap();
2019 assert_eq!(parsed.share_visibility, Some(ShareVisibility::Restricted));
2020 }
2021
2022 #[test]
2023 fn call_record_unshared_has_no_share_visibility() {
2024 // Absent (older platform, or an unshared call) and an explicit
2025 // `null` both read as "not shared" — never `Some(Private)`.
2026 let base = r#"{
2027 "sourceId": "a",
2028 "accountId": "b",
2029 "direction": "inbound",
2030 "party": "anon",
2031 "ringAt": "2026-05-16T10:00:00Z",
2032 "endAt": "2026-05-16T10:00:30Z",
2033 "disposition": "missed",
2034 "endReason": "missed"
2035 }"#;
2036 let parsed: VoiceCallRecord = serde_json::from_str(base).unwrap();
2037 assert_eq!(parsed.share_visibility, None);
2038
2039 let with_null = base.replace(
2040 r#""endReason": "missed""#,
2041 r#""endReason": "missed", "shareVisibility": null"#,
2042 );
2043 let parsed: VoiceCallRecord = serde_json::from_str(&with_null).unwrap();
2044 assert_eq!(parsed.share_visibility, None);
2045 }
2046
2047 #[test]
2048 fn synced_call_omits_share_visibility() {
2049 // `share_visibility` is read-only decoration: a call uploaded via
2050 // sync must not carry it on the wire (skip_serializing_if = None),
2051 // so the round trip from a sync-shaped record stays clean.
2052 let raw = r#"{
2053 "sourceId": "a",
2054 "accountId": "b",
2055 "direction": "inbound",
2056 "party": "anon",
2057 "ringAt": "2026-05-16T10:00:00Z",
2058 "endAt": "2026-05-16T10:00:30Z",
2059 "disposition": "answered",
2060 "endReason": "hangup_remote"
2061 }"#;
2062 let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2063 assert_eq!(parsed.share_visibility, None);
2064 let s = serde_json::to_string(&parsed).unwrap();
2065 assert!(
2066 !s.contains("shareVisibility"),
2067 "sync payload leaked share_visibility: {s}"
2068 );
2069 }
2070
2071 #[test]
2072 fn recording_marker_resource_is_recordings() {
2073 // Path constant drives the URL in `Client::sync_recordings`;
2074 // a rename here would silently 404 against the platform.
2075 assert_eq!(<VoiceRecordings as SyncEndpoint>::RESOURCE, "recordings");
2076 }
2077
2078 #[test]
2079 fn recording_record_serializes_with_camel_case_and_envelope() {
2080 let r = VoiceRecordingRecord {
2081 source_id: "11111111-1111-4111-8111-111111111111".into(),
2082 call_source_id: "22222222-2222-4222-8222-222222222222".into(),
2083 size_bytes: 44 + 64_000,
2084 duration_ms: 2_000,
2085 sample_rate: 8_000,
2086 channels: 2,
2087 created_at: "2026-05-16T10:01:05Z".into(),
2088 envelope: SyncEnvelope::for_endpoint::<VoiceRecordings>(),
2089 };
2090 let s = serde_json::to_string(&r).unwrap();
2091 // Field-by-field wire contract — these strings are also what
2092 // the platform's Zod schema expects.
2093 assert!(s.contains("\"sourceId\":"), "{s}");
2094 assert!(s.contains("\"callSourceId\":"), "{s}");
2095 assert!(s.contains("\"sizeBytes\":64044"), "{s}");
2096 assert!(s.contains("\"durationMs\":2000"), "{s}");
2097 assert!(s.contains("\"sampleRate\":8000"), "{s}");
2098 assert!(s.contains("\"channels\":2"), "{s}");
2099 assert!(s.contains("\"createdAt\":"), "{s}");
2100 // Envelope flattens to the top of the object, same as VoiceCallRecord.
2101 assert!(s.contains("\"schemaVersion\":1"), "{s}");
2102 }
2103
2104 #[test]
2105 fn recordings_sync_response_round_trips() {
2106 // The richer-than-generic response carries per-item provenance —
2107 // the daemon's uploader reads `r2Key` for the bytes follow-up
2108 // and `bytesUploaded` to short-circuit when the row already
2109 // landed on a previous cycle.
2110 let raw = r#"{
2111 "accepted": 2,
2112 "skipped": 0,
2113 "items": [
2114 {"sourceId": "a", "r2Key": "voice/recordings/1/a.wav", "bytesUploaded": false},
2115 {"sourceId": "b", "r2Key": "voice/recordings/1/b.wav", "bytesUploaded": true}
2116 ]
2117 }"#;
2118 let parsed: VoiceRecordingsSyncResponse = serde_json::from_str(raw).unwrap();
2119 assert_eq!(parsed.accepted, 2);
2120 assert_eq!(parsed.items.len(), 2);
2121 assert_eq!(parsed.items[0].r2_key, "voice/recordings/1/a.wav");
2122 assert!(!parsed.items[0].bytes_uploaded);
2123 assert!(parsed.items[1].bytes_uploaded);
2124 }
2125
2126 #[test]
2127 fn install_heartbeat_request_serializes_with_camel_case_keys() {
2128 let req = InstallHeartbeatRequest {
2129 install_id: "11111111-1111-4111-8111-111111111111".into(),
2130 app_version: "0.0.21".into(),
2131 os: "macos".into(),
2132 os_version: Some("15.5.0".into()),
2133 arch: Some("aarch64".into()),
2134 locale: Some("en-NZ".into()),
2135 distribution: Some("mas".into()),
2136 };
2137 let s = serde_json::to_string(&req).unwrap();
2138 assert!(s.contains("\"installId\":"), "{s}");
2139 assert!(s.contains("\"appVersion\":\"0.0.21\""), "{s}");
2140 assert!(s.contains("\"os\":\"macos\""), "{s}");
2141 assert!(s.contains("\"osVersion\":\"15.5.0\""), "{s}");
2142 assert!(s.contains("\"arch\":\"aarch64\""), "{s}");
2143 assert!(s.contains("\"locale\":\"en-NZ\""), "{s}");
2144 assert!(s.contains("\"distribution\":\"mas\""), "{s}");
2145 }
2146
2147 #[test]
2148 fn install_heartbeat_request_omits_absent_optional_fields() {
2149 // A host where the OS version / locale probe came up empty
2150 // shouldn't send `null` — keeping the keys out lets the
2151 // platform's Zod `.optional()` accept the body and the column
2152 // stay NULL rather than the string "null".
2153 let req = InstallHeartbeatRequest {
2154 install_id: "x".into(),
2155 app_version: "0.0.21".into(),
2156 os: "linux".into(),
2157 os_version: None,
2158 arch: None,
2159 locale: None,
2160 distribution: None,
2161 };
2162 let s = serde_json::to_string(&req).unwrap();
2163 assert!(!s.contains("osVersion"), "osVersion should be omitted: {s}");
2164 assert!(!s.contains("arch"), "arch should be omitted: {s}");
2165 assert!(!s.contains("locale"), "locale should be omitted: {s}");
2166 assert!(
2167 !s.contains("distribution"),
2168 "distribution should be omitted: {s}"
2169 );
2170 }
2171
2172 #[test]
2173 fn install_heartbeat_response_parses_platform_shape() {
2174 let raw = r#"{
2175 "id": "abc-123",
2176 "installId": "11111111-1111-4111-8111-111111111111",
2177 "appVersion": "0.0.21",
2178 "os": "macos",
2179 "osVersion": "15.5.0",
2180 "arch": "aarch64",
2181 "locale": null,
2182 "firstSeenAt": "2026-05-31T10:00:00.000Z",
2183 "lastSeenAt": "2026-05-31T10:00:00.000Z"
2184 }"#;
2185 let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2186 assert_eq!(parsed.id, "abc-123");
2187 assert_eq!(parsed.app_version, "0.0.21");
2188 assert_eq!(parsed.os_version.as_deref(), Some("15.5.0"));
2189 assert!(parsed.locale.is_none());
2190 // The fixture above carries no `distribution` key at all, which
2191 // is what a platform deployed before the field looks like. It
2192 // must parse, not error — hence `#[serde(default)]`.
2193 assert!(parsed.distribution.is_none());
2194 }
2195
2196 #[test]
2197 fn install_heartbeat_response_reads_the_distribution_back() {
2198 let raw = r#"{
2199 "id": "abc-123",
2200 "installId": "11111111-1111-4111-8111-111111111111",
2201 "appVersion": "0.0.48",
2202 "os": "macos",
2203 "osVersion": "15.5.0",
2204 "arch": "aarch64",
2205 "locale": "en-NZ",
2206 "distribution": "mas",
2207 "firstSeenAt": "2026-08-22T10:00:00.000Z",
2208 "lastSeenAt": "2026-08-22T10:00:00.000Z"
2209 }"#;
2210 let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2211 assert_eq!(parsed.distribution.as_deref(), Some("mas"));
2212 }
2213
2214 #[test]
2215 fn install_heartbeat_response_accepts_an_unknown_distribution() {
2216 // Free text by contract: the platform stores whatever arrives so
2217 // a new distribution can ship without a server release. Parsing
2218 // it into an enum here would undo that on the client side.
2219 let raw = r#"{
2220 "id": "abc-123",
2221 "installId": "11111111-1111-4111-8111-111111111111",
2222 "appVersion": "0.1.0",
2223 "os": "windows",
2224 "osVersion": null,
2225 "arch": "x86_64",
2226 "locale": null,
2227 "distribution": "msstore",
2228 "firstSeenAt": "2026-08-22T10:00:00.000Z",
2229 "lastSeenAt": "2026-08-22T10:00:00.000Z"
2230 }"#;
2231 let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2232 assert_eq!(parsed.distribution.as_deref(), Some("msstore"));
2233 }
2234
2235 #[test]
2236 fn system_info_detect_fills_os_and_arch() {
2237 // os / arch come from compile-time consts, so they're always
2238 // non-empty on every supported target. os_version / locale are
2239 // best-effort and intentionally not asserted.
2240 let sys = SystemInfo::detect();
2241 assert!(!sys.os.is_empty(), "os should be a non-empty target string");
2242 assert!(
2243 !sys.arch.is_empty(),
2244 "arch should be a non-empty target string"
2245 );
2246 }
2247
2248 #[test]
2249 fn transcripts_marker_resource_is_transcripts() {
2250 assert_eq!(<VoiceTranscripts as SyncEndpoint>::RESOURCE, "transcripts");
2251 }
2252
2253 #[test]
2254 fn transcript_record_serializes_with_camel_case_and_channel_enum() {
2255 let r = VoiceTranscriptRecord {
2256 source_id: "1".into(),
2257 call_source_id: "22222222-2222-4222-8222-222222222222".into(),
2258 channel: VoiceTranscriptChannel::Remote,
2259 ts_ms: 100,
2260 end_ms: 1_500,
2261 text: "hello".into(),
2262 envelope: SyncEnvelope::for_endpoint::<VoiceTranscripts>(),
2263 };
2264 let s = serde_json::to_string(&r).unwrap();
2265 assert!(s.contains("\"sourceId\":"), "{s}");
2266 assert!(s.contains("\"callSourceId\":"), "{s}");
2267 // The channel enum is wire-stable snake_case — matches the
2268 // platform's Zod `enum(VOICE_TRANSCRIPT_CHANNELS)`.
2269 assert!(s.contains("\"channel\":\"remote\""), "{s}");
2270 assert!(s.contains("\"tsMs\":100"), "{s}");
2271 assert!(s.contains("\"endMs\":1500"), "{s}");
2272 assert!(s.contains("\"text\":\"hello\""), "{s}");
2273 assert!(s.contains("\"schemaVersion\":1"), "{s}");
2274 }
2275
2276 #[test]
2277 fn share_visibility_pins_its_wire_strings() {
2278 // The platform validates these against an exact string list; a
2279 // rename would bounce every share command with a 400.
2280 assert_eq!(
2281 serde_json::to_string(&ShareVisibility::Private).unwrap(),
2282 "\"private\""
2283 );
2284 assert_eq!(
2285 serde_json::to_string(&ShareVisibility::Restricted).unwrap(),
2286 "\"restricted\""
2287 );
2288 assert_eq!(
2289 serde_json::to_string(&ShareVisibility::Public).unwrap(),
2290 "\"public\""
2291 );
2292 for v in [
2293 ShareVisibility::Private,
2294 ShareVisibility::Restricted,
2295 ShareVisibility::Public,
2296 ] {
2297 let s = serde_json::to_string(&v).unwrap();
2298 let back: ShareVisibility = serde_json::from_str(&s).unwrap();
2299 assert_eq!(v, back);
2300 }
2301 }
2302
2303 #[test]
2304 fn share_request_serializes_with_camel_case_and_omits_unset() {
2305 let req = ShareRecordingRequest {
2306 recording_source_id: "11111111-1111-4111-8111-111111111111".into(),
2307 visibility: ShareVisibility::Public,
2308 invited_emails: None,
2309 party_masking: None,
2310 show_transcript: None,
2311 show_audio: None,
2312 allow_download: None,
2313 default_mute_local: None,
2314 default_mute_remote: None,
2315 password: None,
2316 expires_at: None,
2317 };
2318 let s = serde_json::to_string(&req).unwrap();
2319 assert!(s.contains("\"recordingSourceId\":"), "{s}");
2320 assert!(s.contains("\"visibility\":\"public\""), "{s}");
2321 // Phase-2 / tier-specific / visibility-control fields stay off the
2322 // wire when unset so the platform's `.optional()` schema accepts the
2323 // body (and the omitted controls fall to the platform defaults).
2324 assert!(!s.contains("invitedEmails"), "{s}");
2325 assert!(!s.contains("partyMasking"), "{s}");
2326 assert!(!s.contains("showTranscript"), "{s}");
2327 assert!(!s.contains("showAudio"), "{s}");
2328 assert!(!s.contains("allowDownload"), "{s}");
2329 assert!(!s.contains("defaultMuteLocal"), "{s}");
2330 assert!(!s.contains("defaultMuteRemote"), "{s}");
2331 assert!(!s.contains("password"), "{s}");
2332 assert!(!s.contains("expiresAt"), "{s}");
2333 }
2334
2335 #[test]
2336 fn share_request_serializes_visibility_controls_camel_case() {
2337 let req = ShareRecordingRequest {
2338 recording_source_id: "a".into(),
2339 visibility: ShareVisibility::Public,
2340 invited_emails: None,
2341 party_masking: Some(PartyMasking::Partial),
2342 show_transcript: Some(false),
2343 show_audio: Some(true),
2344 allow_download: Some(true),
2345 default_mute_local: Some(false),
2346 default_mute_remote: Some(true),
2347 password: None,
2348 expires_at: None,
2349 };
2350 let s = serde_json::to_string(&req).unwrap();
2351 assert!(s.contains("\"partyMasking\":\"partial\""), "{s}");
2352 assert!(s.contains("\"showTranscript\":false"), "{s}");
2353 assert!(s.contains("\"showAudio\":true"), "{s}");
2354 assert!(s.contains("\"allowDownload\":true"), "{s}");
2355 // The owner muted their own side by default but left the other
2356 // party audible — both ride the wire as camelCase booleans.
2357 assert!(s.contains("\"defaultMuteLocal\":false"), "{s}");
2358 assert!(s.contains("\"defaultMuteRemote\":true"), "{s}");
2359 }
2360
2361 #[test]
2362 fn share_request_carries_invited_emails_for_restricted() {
2363 let req = ShareRecordingRequest {
2364 recording_source_id: "a".into(),
2365 visibility: ShareVisibility::Restricted,
2366 invited_emails: Some(vec!["alex@example.com".into()]),
2367 party_masking: None,
2368 show_transcript: None,
2369 show_audio: None,
2370 allow_download: None,
2371 default_mute_local: None,
2372 default_mute_remote: None,
2373 password: None,
2374 expires_at: None,
2375 };
2376 let s = serde_json::to_string(&req).unwrap();
2377 assert!(s.contains("\"visibility\":\"restricted\""), "{s}");
2378 assert!(
2379 s.contains("\"invitedEmails\":[\"alex@example.com\"]"),
2380 "{s}"
2381 );
2382 }
2383
2384 #[test]
2385 fn share_response_parses_platform_shape() {
2386 let raw = r#"{
2387 "visibility": "public",
2388 "token": "Zr7-x9F2k1QpLmN4sT8wYa",
2389 "shareUrl": "https://platform.wavekat.com/voice/s/Zr7-x9F2k1QpLmN4sT8wYa",
2390 "sharedAt": "2026-06-19T10:00:00.000Z"
2391 }"#;
2392 let parsed: ShareRecordingResponse = serde_json::from_str(raw).unwrap();
2393 assert_eq!(parsed.visibility, ShareVisibility::Public);
2394 assert_eq!(parsed.token, "Zr7-x9F2k1QpLmN4sT8wYa");
2395 assert!(parsed.share_url.ends_with(&parsed.token));
2396 }
2397
2398 #[test]
2399 fn share_state_parses_restricted_with_invited_emails() {
2400 // The GET read carries the audience back — this is the field the
2401 // POST reply omits and the desktop "who can open this" panel needs.
2402 let raw = r#"{
2403 "visibility": "restricted",
2404 "token": "Zr7-x9F2k1QpLmN4sT8wYa",
2405 "shareUrl": "https://platform.wavekat.com/voice/s/Zr7-x9F2k1QpLmN4sT8wYa",
2406 "sharedAt": "2026-06-19T10:00:00.000Z",
2407 "invitedEmails": ["bob@example.com", "carol@example.com"],
2408 "partyMasking": "full",
2409 "showTranscript": true,
2410 "showAudio": false,
2411 "allowDownload": false,
2412 "defaultMuteLocal": false,
2413 "defaultMuteRemote": true
2414 }"#;
2415 let parsed: ShareStateResponse = serde_json::from_str(raw).unwrap();
2416 assert_eq!(parsed.visibility, ShareVisibility::Restricted);
2417 assert_eq!(
2418 parsed.invited_emails.as_deref(),
2419 Some(
2420 [
2421 "bob@example.com".to_string(),
2422 "carol@example.com".to_string()
2423 ]
2424 .as_slice()
2425 )
2426 );
2427 // The visibility controls ride back on the live-share read.
2428 assert_eq!(parsed.party_masking, Some(PartyMasking::Full));
2429 assert_eq!(parsed.show_transcript, Some(true));
2430 assert_eq!(parsed.show_audio, Some(false));
2431 // Audio hidden here, so download comes back off (platform folds the two).
2432 assert_eq!(parsed.allow_download, Some(false));
2433 // Per-channel playback defaults ride back too.
2434 assert_eq!(parsed.default_mute_local, Some(false));
2435 assert_eq!(parsed.default_mute_remote, Some(true));
2436 }
2437
2438 #[test]
2439 fn share_state_parses_private_with_fields_absent() {
2440 // A never-shared (or revoked) recording reports private with no
2441 // token / url / emails — the optional fields stay None.
2442 let parsed: ShareStateResponse =
2443 serde_json::from_str(r#"{ "visibility": "private" }"#).unwrap();
2444 assert_eq!(parsed.visibility, ShareVisibility::Private);
2445 assert!(parsed.token.is_none());
2446 assert!(parsed.share_url.is_none());
2447 assert!(parsed.shared_at.is_none());
2448 assert!(parsed.invited_emails.is_none());
2449 }
2450
2451 #[test]
2452 fn share_request_rejects_empty_source_id_before_hitting_network() {
2453 // Guarded client-side so an empty id can't produce a path like
2454 // `/api/voice/recordings//share` that 404s confusingly.
2455 let req = ShareRecordingRequest {
2456 recording_source_id: String::new(),
2457 visibility: ShareVisibility::Private,
2458 invited_emails: None,
2459 party_masking: None,
2460 show_transcript: None,
2461 show_audio: None,
2462 allow_download: None,
2463 default_mute_local: None,
2464 default_mute_remote: None,
2465 password: None,
2466 expires_at: None,
2467 };
2468 // We can't call the async method without a runtime here, but the
2469 // guard mirrors `upload_recording_bytes` — assert the precondition
2470 // shape the method checks.
2471 assert!(req.recording_source_id.is_empty());
2472 }
2473
2474 // ---- VoiceAccounts ----
2475
2476 fn sample_account() -> VoiceAccountRecord {
2477 VoiceAccountRecord {
2478 source_id: "11111111-1111-4111-8111-111111111111".into(),
2479 enabled: true,
2480 display_name: "Work line".into(),
2481 username: "alice".into(),
2482 domain: "sip.example.com".into(),
2483 auth_username: Some("alice-auth".into()),
2484 server: Some("sip.example.com".into()),
2485 port: Some(5060),
2486 transport: VoiceTransport::Udp,
2487 register_expires: 60,
2488 keepalive_secs: Some(50),
2489 disclosure_enabled: true,
2490 updated_at: "2026-06-20T10:00:00Z".into(),
2491 deleted_at: None,
2492 envelope: SyncEnvelope::for_endpoint::<VoiceAccounts>(),
2493 }
2494 }
2495
2496 #[test]
2497 fn accounts_marker_resource_is_accounts() {
2498 // Path constant drives the URL in `Client::sync` / `Client::list`;
2499 // a rename here would silently 404 against the platform.
2500 assert_eq!(<VoiceAccounts as SyncEndpoint>::RESOURCE, "accounts");
2501 }
2502
2503 #[test]
2504 fn account_record_serializes_with_camel_case_and_envelope() {
2505 let s = serde_json::to_string(&sample_account()).unwrap();
2506 // Field-by-field wire contract — also what the platform's Zod
2507 // schema expects.
2508 assert!(s.contains("\"sourceId\":"), "{s}");
2509 assert!(s.contains("\"displayName\":\"Work line\""), "{s}");
2510 assert!(s.contains("\"authUsername\":\"alice-auth\""), "{s}");
2511 assert!(s.contains("\"registerExpires\":60"), "{s}");
2512 assert!(s.contains("\"keepaliveSecs\":50"), "{s}");
2513 assert!(s.contains("\"disclosureEnabled\":true"), "{s}");
2514 assert!(s.contains("\"transport\":\"udp\""), "{s}");
2515 assert!(s.contains("\"updatedAt\":\"2026-06-20T10:00:00Z\""), "{s}");
2516 // A live line carries no tombstone.
2517 assert!(!s.contains("deletedAt"), "deletedAt should be omitted: {s}");
2518 // The secret never crosses this wire, by construction.
2519 assert!(!s.contains("password"), "no password field: {s}");
2520 // Envelope flattens to the top, same as the other resources.
2521 assert!(s.contains("\"schemaVersion\":1"), "{s}");
2522 }
2523
2524 #[test]
2525 fn account_tombstone_serializes_deleted_at() {
2526 // A soft-delete rides as an upsert with deletedAt set — the
2527 // delete-propagation mechanism (doc 40).
2528 let mut r = sample_account();
2529 r.deleted_at = Some("2026-06-20T12:00:00Z".into());
2530 let s = serde_json::to_string(&r).unwrap();
2531 assert!(s.contains("\"deletedAt\":\"2026-06-20T12:00:00Z\""), "{s}");
2532 }
2533
2534 #[test]
2535 fn account_record_round_trips_optional_fields() {
2536 // A minimal line — no auth username, server, port, keepalive, or
2537 // tombstone — should parse with those all absent.
2538 let raw = r#"{
2539 "sourceId": "a",
2540 "enabled": false,
2541 "displayName": "Cheap trunk",
2542 "username": "u",
2543 "domain": "d",
2544 "transport": "tcp",
2545 "registerExpires": 120,
2546 "disclosureEnabled": false,
2547 "updatedAt": "2026-06-20T10:00:00Z"
2548 }"#;
2549 let parsed: VoiceAccountRecord = serde_json::from_str(raw).unwrap();
2550 assert!(!parsed.enabled);
2551 assert!(parsed.auth_username.is_none());
2552 assert!(parsed.server.is_none());
2553 assert!(parsed.port.is_none());
2554 assert!(parsed.keepalive_secs.is_none());
2555 assert!(parsed.deleted_at.is_none());
2556 assert_eq!(parsed.transport, VoiceTransport::Tcp);
2557 assert_eq!(parsed.register_expires, 120);
2558 }
2559
2560 #[test]
2561 fn voice_transport_round_trips_via_json() {
2562 for t in [VoiceTransport::Udp, VoiceTransport::Tcp] {
2563 let s = serde_json::to_string(&t).unwrap();
2564 let back: VoiceTransport = serde_json::from_str(&s).unwrap();
2565 assert_eq!(t, back);
2566 }
2567 // Pin the wire strings — the daemon's `TransportKind` and the
2568 // platform's Zod enum both depend on these exact tokens.
2569 assert_eq!(
2570 serde_json::to_string(&VoiceTransport::Udp).unwrap(),
2571 "\"udp\""
2572 );
2573 assert_eq!(
2574 serde_json::to_string(&VoiceTransport::Tcp).unwrap(),
2575 "\"tcp\""
2576 );
2577 }
2578
2579 #[test]
2580 fn accounts_query_omits_unset_and_serializes_include_deleted() {
2581 let empty = serde_json::to_string(&VoiceAccountsQuery::default()).unwrap();
2582 assert_eq!(empty, "{}", "default query should be empty: {empty}");
2583 let with_deleted = serde_json::to_string(&VoiceAccountsQuery {
2584 include_deleted: Some(true),
2585 })
2586 .unwrap();
2587 assert!(
2588 with_deleted.contains("\"includeDeleted\":true"),
2589 "{with_deleted}"
2590 );
2591 }
2592
2593 // ---- VoiceFlows ----
2594
2595 #[test]
2596 fn flows_query_serializes_cursor_and_omits_absent_fields() {
2597 let empty = serde_json::to_string(&VoiceFlowsQuery::default()).unwrap();
2598 assert_eq!(empty, "{}");
2599 let cursored = serde_json::to_string(&VoiceFlowsQuery {
2600 after: Some("flow_abc".into()),
2601 limit: Some(100),
2602 schema_versions: None,
2603 })
2604 .unwrap();
2605 assert!(cursored.contains("\"after\":\"flow_abc\""), "{cursored}");
2606 assert!(cursored.contains("\"limit\":100"), "{cursored}");
2607 }
2608
2609 #[test]
2610 fn flows_query_sends_schema_versions_under_the_servers_name() {
2611 // The struct is camelCase; this parameter is not. A silently
2612 // camelCased key is ignored by the server, which reads exactly
2613 // like an account with no flows in that version — so pin it.
2614 let query = serde_json::to_string(&VoiceFlowsQuery {
2615 schema_versions: Some("1,2".into()),
2616 ..Default::default()
2617 })
2618 .unwrap();
2619 assert_eq!(query, r#"{"schema_versions":"1,2"}"#);
2620 }
2621
2622 // ---- Booking ----
2623
2624 #[test]
2625 fn booking_slots_request_uses_the_routes_snake_case_wire() {
2626 // Unlike the sync resources above, these routes speak snake_case.
2627 // A camelCased body is rejected as a validation error mid-call,
2628 // which the flow can only render as "unavailable".
2629 let body = serde_json::to_string(&BookingSlotsRequest {
2630 source_id: "call_1".into(),
2631 duration_mins: 30,
2632 buffer_mins: 10,
2633 lead_mins: 120,
2634 horizon_days: 14,
2635 schedule: BookingSchedule {
2636 tue: vec![BookingTimeRange {
2637 open: "09:00".into(),
2638 close: "17:00".into(),
2639 }],
2640 ..Default::default()
2641 },
2642 timezone: "Pacific/Auckland".into(),
2643 exceptions: Vec::new(),
2644 limit: 3,
2645 })
2646 .unwrap();
2647 assert!(body.contains(r#""source_id":"call_1""#), "{body}");
2648 assert!(body.contains(r#""duration_mins":30"#), "{body}");
2649 assert!(body.contains(r#""timezone":"Pacific/Auckland""#), "{body}");
2650 // Days with no hours, and an empty exception list, stay off the
2651 // wire entirely rather than shipping empty arrays.
2652 assert!(!body.contains("\"mon\""), "{body}");
2653 assert!(!body.contains("exceptions"), "{body}");
2654 }
2655
2656 #[test]
2657 fn booking_slots_response_parses_both_answers() {
2658 let offered: BookingSlotsResponse = serde_json::from_str(
2659 r#"{"slots":[{"start":"2026-08-11T21:00:00Z","end":"2026-08-11T21:30:00Z"}],"timezone":"Pacific/Auckland"}"#,
2660 )
2661 .unwrap();
2662 assert_eq!(offered.slots.len(), 1);
2663 assert_eq!(offered.timezone, "Pacific/Auckland");
2664 assert!(offered.status.is_none());
2665
2666 // The calendar could not be read. Not an error to the caller of
2667 // this crate — the flow has an exit for it.
2668 let down: BookingSlotsResponse =
2669 serde_json::from_str(r#"{"status":"unavailable","reason":"not_connected"}"#).unwrap();
2670 assert!(down.slots.is_empty());
2671 assert_eq!(down.status.as_deref(), Some("unavailable"));
2672 assert_eq!(down.reason.as_deref(), Some("not_connected"));
2673 }
2674
2675 #[test]
2676 fn booking_book_response_parses_every_outcome() {
2677 let booked: BookingBookResponse =
2678 serde_json::from_str(r#"{"status":"booked","start":"2026-08-11T21:00:00Z"}"#).unwrap();
2679 assert_eq!(booked.status, "booked");
2680 assert_eq!(booked.start.as_deref(), Some("2026-08-11T21:00:00Z"));
2681
2682 let taken: BookingBookResponse =
2683 serde_json::from_str(r#"{"status":"slot_taken"}"#).unwrap();
2684 assert_eq!(taken.status, "slot_taken");
2685 assert!(taken.start.is_none());
2686
2687 // A status this build has never heard of still parses: failing
2688 // here would drop a live call over an unknown string.
2689 let future: BookingBookResponse =
2690 serde_json::from_str(r#"{"status":"needs_deposit"}"#).unwrap();
2691 assert_eq!(future.status, "needs_deposit");
2692 }
2693
2694 #[test]
2695 fn flows_page_parses_platform_shape() {
2696 let raw = r#"{
2697 "items": [{
2698 "id": "flow_1",
2699 "name": "Luigi's — after hours",
2700 "version": 3,
2701 "yaml": "schema_version: 1\n",
2702 "publishedAt": "2026-07-13T10:00:00Z"
2703 }],
2704 "nextAfter": null
2705 }"#;
2706 let page: VoiceFlowsPage = serde_json::from_str(raw).unwrap();
2707 assert_eq!(page.items.len(), 1);
2708 let rec = &page.items[0];
2709 assert_eq!(rec.id, "flow_1");
2710 assert_eq!(rec.version, 3);
2711 assert_eq!(rec.published_at, "2026-07-13T10:00:00Z");
2712 assert!(page.next_after.is_none());
2713
2714 // A mid-walk page carries the cursor.
2715 let more: VoiceFlowsPage =
2716 serde_json::from_str(r#"{ "items": [], "nextAfter": "flow_1" }"#).unwrap();
2717 assert_eq!(more.next_after.as_deref(), Some("flow_1"));
2718 }
2719
2720 #[test]
2721 fn flow_assets_manifest_parses_platform_shape() {
2722 // `ref` (a reserved word) maps to `asset_ref`; a null duration is
2723 // accepted (the platform doesn't always know it).
2724 let raw = r#"{
2725 "assets": [{
2726 "ref": "vprompt_ab12cd34",
2727 "format": "ulaw_8000",
2728 "byteSize": 48044,
2729 "durationMs": null,
2730 "contentHash": "9f2c00aa"
2731 }]
2732 }"#;
2733 let page: VoiceFlowAssetsPage = serde_json::from_str(raw).unwrap();
2734 assert_eq!(page.assets.len(), 1);
2735 let asset = &page.assets[0];
2736 assert_eq!(asset.asset_ref, "vprompt_ab12cd34");
2737 assert_eq!(asset.format, "ulaw_8000");
2738 assert_eq!(asset.byte_size, 48044);
2739 assert!(asset.duration_ms.is_none());
2740 assert_eq!(asset.content_hash, "9f2c00aa");
2741
2742 // A text-only version legitimately has no frozen audio.
2743 let empty: VoiceFlowAssetsPage = serde_json::from_str(r#"{ "assets": [] }"#).unwrap();
2744 assert!(empty.assets.is_empty());
2745 }
2746
2747 #[test]
2748 fn account_record_accepts_unknown_extras_for_forward_compat() {
2749 // A newer client shipping a field this platform version lacks a
2750 // column for round-trips via the `extras` envelope.
2751 let raw = r#"{
2752 "sourceId": "a",
2753 "enabled": true,
2754 "displayName": "x",
2755 "username": "u",
2756 "domain": "d",
2757 "transport": "udp",
2758 "registerExpires": 60,
2759 "disclosureEnabled": true,
2760 "updatedAt": "2026-06-20T10:00:00Z",
2761 "schemaVersion": 2,
2762 "extras": { "ringtone": "classic" }
2763 }"#;
2764 let parsed: VoiceAccountRecord = serde_json::from_str(raw).unwrap();
2765 assert_eq!(parsed.envelope.schema_version, Some(2));
2766 let extras = parsed.envelope.extras.as_ref().expect("extras present");
2767 assert_eq!(extras["ringtone"], "classic");
2768 }
2769
2770 #[test]
2771 fn system_flow_record_parses_the_platform_shape() {
2772 // The full wire shape as served by the platform's system flow
2773 // endpoint: all fields present including optionals.
2774 let json = r#"{
2775 "id": "flow_voicemail",
2776 "name": "Voicemail",
2777 "description": "A short greeting.",
2778 "language": "en",
2779 "version": 2,
2780 "yaml": "schema_version: 1\n",
2781 "publishedAt": "2026-08-27 01:02:03",
2782 "access": "open",
2783 "systemTags": ["system", "access:open"]
2784 }"#;
2785 let rec: VoiceSystemFlowRecord = serde_json::from_str(json).unwrap();
2786 assert_eq!(rec.id, "flow_voicemail");
2787 assert_eq!(rec.name, "Voicemail");
2788 assert_eq!(rec.description, "A short greeting.");
2789 assert_eq!(rec.language, "en");
2790 assert_eq!(rec.version, 2);
2791 assert_eq!(rec.yaml, "schema_version: 1\n");
2792 assert_eq!(rec.published_at, Some("2026-08-27 01:02:03".into()));
2793 assert_eq!(rec.access, "open");
2794 assert_eq!(rec.system_tags, vec!["system", "access:open"]);
2795 }
2796
2797 #[test]
2798 fn system_flow_record_tolerates_missing_optionals_and_unknown_fields() {
2799 // Older rows or newer platforms: description, publishedAt,
2800 // systemTags may be absent; unknown fields must be ignored
2801 // (forward compat).
2802 let json = r#"{"id":"f","name":"n","language":"en","version":1,"yaml":"y","access":"account","someFutureField":1}"#;
2803 let rec: VoiceSystemFlowRecord = serde_json::from_str(json).unwrap();
2804 assert_eq!(rec.id, "f");
2805 assert_eq!(rec.name, "n");
2806 assert_eq!(rec.description, "");
2807 assert_eq!(rec.language, "en");
2808 assert_eq!(rec.version, 1);
2809 assert_eq!(rec.yaml, "y");
2810 assert!(rec.published_at.is_none());
2811 assert_eq!(rec.access, "account");
2812 assert!(rec.system_tags.is_empty());
2813 }
2814}