Skip to main content

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, PartialEq, 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    /// Fleet-admin fields (build provenance, update-channel and
1148    /// updater state, native arch, process start time). Flattened onto
1149    /// the wire so the body stays flat JSON even though the daemon
1150    /// builds one value; see [`InstallHeartbeatFleet`].
1151    #[serde(flatten, default)]
1152    pub fleet: InstallHeartbeatFleet,
1153}
1154
1155/// Optional fleet-admin fields on the install heartbeat, grouped so the
1156/// daemon can build (and the platform's fleet-admin view can read) one
1157/// value rather than ten loose arguments. Flattened onto
1158/// [`InstallHeartbeatRequest`] via `#[serde(flatten)]`, so on the wire
1159/// these fields sit alongside `installId` / `appVersion` / … with no
1160/// nesting.
1161///
1162/// Every field is optional and additive: an older daemon that never
1163/// sets them sends a body identical to the one before this struct
1164/// existed (an all-`None` `InstallHeartbeatFleet` serializes to no
1165/// extra keys), and a platform that hasn't deployed the corresponding
1166/// migration yet simply stores nulls. Read by `wavekat-platform`'s
1167/// fleet-admin view (docs/45) — keep every field optional so this
1168/// remains safe to send against an older platform and safe to omit
1169/// from an older daemon.
1170#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
1171#[serde(rename_all = "camelCase")]
1172pub struct InstallHeartbeatFleet {
1173    /// The git SHA the daemon binary was built from.
1174    #[serde(default, skip_serializing_if = "Option::is_none")]
1175    pub build_sha: Option<String>,
1176    /// How this copy was obtained, at a finer grain than
1177    /// [`InstallHeartbeatRequest::distribution`] — e.g. `"mas"`,
1178    /// `"msstore"`, `"snap"`, `"appimage"`, `"deb"`, `"direct"`,
1179    /// `"dev"`. Free text by contract, not an enum: the platform
1180    /// stores whatever arrives so a new install source can ship
1181    /// without a server release.
1182    #[serde(default, skip_serializing_if = "Option::is_none")]
1183    pub install_source: Option<String>,
1184    /// Which release channel this build tracks — `"stable"` or
1185    /// `"beta"`.
1186    #[serde(default, skip_serializing_if = "Option::is_none")]
1187    pub update_channel: Option<String>,
1188    /// Whether the daemon's self-updater is active. `false` where the
1189    /// updater is inert because the platform's own store owns updates
1190    /// instead (Mac App Store, Microsoft Store) or the build is
1191    /// unpackaged.
1192    #[serde(default, skip_serializing_if = "Option::is_none")]
1193    pub updater_enabled: Option<bool>,
1194    /// The self-updater's current state machine status — `"idle"`,
1195    /// `"checking"`, `"available"`, `"downloading"`, `"downloaded"`,
1196    /// `"not-available"`, or `"error"`.
1197    #[serde(default, skip_serializing_if = "Option::is_none")]
1198    pub updater_status: Option<String>,
1199    /// The version the updater has staged or is offering, when there
1200    /// is one pending.
1201    #[serde(default, skip_serializing_if = "Option::is_none")]
1202    pub updater_version: Option<String>,
1203    /// ISO-8601 timestamp of the updater's last check.
1204    #[serde(default, skip_serializing_if = "Option::is_none")]
1205    pub updater_checked_at: Option<String>,
1206    /// The updater's last error message, if any. At most 256
1207    /// characters — the caller truncates before sending.
1208    #[serde(default, skip_serializing_if = "Option::is_none")]
1209    pub updater_error: Option<String>,
1210    /// `os.machine()` — the host's native architecture. Differs from
1211    /// `arch` when the process is running under translation (e.g.
1212    /// Rosetta on Apple Silicon).
1213    #[serde(default, skip_serializing_if = "Option::is_none")]
1214    pub native_arch: Option<String>,
1215    /// ISO-8601 timestamp of when the daemon process started.
1216    #[serde(default, skip_serializing_if = "Option::is_none")]
1217    pub started_at: Option<String>,
1218    /// Whether a call flow is armed on at least one line right now.
1219    ///
1220    /// The one activation fact that is *state* rather than a milestone,
1221    /// so it rides the periodic snapshot; "did this install ever add an
1222    /// account / register / connect a call" are milestones and go
1223    /// through [`Client::install_usage_events_with`] instead. A yes/no
1224    /// by design — the anonymous ping carries no identity. Absent means
1225    /// "not reported by this build", never "no": the platform stores
1226    /// NULL and reads it as unknown.
1227    #[serde(default, skip_serializing_if = "Option::is_none")]
1228    pub flow_armed: Option<bool>,
1229}
1230
1231/// The platform's view of an install row, echoed back from a heartbeat.
1232#[derive(Debug, Clone, Serialize, Deserialize)]
1233#[serde(rename_all = "camelCase")]
1234pub struct InstallHeartbeatResponse {
1235    pub id: String,
1236    pub install_id: String,
1237    pub app_version: String,
1238    pub os: String,
1239    pub os_version: Option<String>,
1240    pub arch: Option<String>,
1241    pub locale: Option<String>,
1242    /// Echoed back. `#[serde(default)]` because a platform deployed
1243    /// before this field existed omits the key rather than sending null,
1244    /// and a heartbeat must not fail to parse against an older server.
1245    #[serde(default)]
1246    pub distribution: Option<String>,
1247    pub first_seen_at: String,
1248    pub last_seen_at: String,
1249}
1250
1251impl Client {
1252    /// `POST /api/voice/installs/heartbeat` — the anonymous, no-auth
1253    /// first-run install ping. Detects the host environment internally
1254    /// and posts it alongside the caller-supplied `install_id` +
1255    /// `app_version`. Associated (not a method) because the endpoint is
1256    /// unauthenticated — there's no token, and at first run there's no
1257    /// signed-in `Client` to hang it off of.
1258    ///
1259    /// Though unauthenticated, the request is **signed** with the release
1260    /// credential `cred` (a per-version Ed25519 key + master-issued
1261    /// certificate the consumer bakes in at build time) so the platform
1262    /// can verify it came from a genuine release and reject forged or
1263    /// replayed pings — see [`Client::post_public_signed_json`] and
1264    /// [`crate::sign`]. The platform needs only the master *public* key to
1265    /// verify.
1266    ///
1267    /// `base_url` is the platform base (e.g. `https://platform.wavekat.com`).
1268    ///
1269    /// `distribution` says how this copy was obtained (`"direct"`,
1270    /// `"mas"`, …). It is the one field this call can't detect for
1271    /// itself — see [`InstallHeartbeatRequest::distribution`] — so pass
1272    /// `None` if the consumer has nothing meaningful to say.
1273    ///
1274    /// Sends no fleet-admin fields (see [`InstallHeartbeatFleet`]) — a
1275    /// thin wrapper over [`Client::install_heartbeat_with`] for
1276    /// callers that don't have them. Consumers that do should call
1277    /// [`Client::install_heartbeat_with`] directly instead.
1278    pub async fn install_heartbeat(
1279        base_url: &str,
1280        install_id: &str,
1281        app_version: &str,
1282        distribution: Option<&str>,
1283        cred: &ReleaseCredential,
1284    ) -> Result<InstallHeartbeatResponse> {
1285        Client::install_heartbeat_with(
1286            base_url,
1287            install_id,
1288            app_version,
1289            distribution,
1290            cred,
1291            InstallHeartbeatFleet::default(),
1292        )
1293        .await
1294    }
1295
1296    /// As [`Client::install_heartbeat`], but also takes the
1297    /// fleet-admin fields (build provenance, update-channel and
1298    /// updater state, native arch, process start time) that a
1299    /// fleet-aware daemon can supply — see [`InstallHeartbeatFleet`].
1300    /// Pass `InstallHeartbeatFleet::default()` for a caller with
1301    /// nothing to report; [`Client::install_heartbeat`] does exactly
1302    /// that.
1303    pub async fn install_heartbeat_with(
1304        base_url: &str,
1305        install_id: &str,
1306        app_version: &str,
1307        distribution: Option<&str>,
1308        cred: &ReleaseCredential,
1309        fleet: InstallHeartbeatFleet,
1310    ) -> Result<InstallHeartbeatResponse> {
1311        let sys = SystemInfo::detect();
1312        let body = InstallHeartbeatRequest {
1313            install_id: install_id.to_string(),
1314            app_version: app_version.to_string(),
1315            os: sys.os,
1316            os_version: sys.os_version,
1317            arch: Some(sys.arch),
1318            locale: sys.locale,
1319            distribution: distribution.map(str::to_string),
1320            fleet,
1321        };
1322        Client::post_public_signed_json::<InstallHeartbeatResponse, _>(
1323            base_url,
1324            "/api/voice/installs/heartbeat",
1325            &body,
1326            cred,
1327        )
1328        .await
1329    }
1330
1331    /// `POST /api/voice/installs/events` — the anonymous usage-event
1332    /// batch that accompanies the install heartbeat. Same trust model
1333    /// as [`Client::install_heartbeat_with`]: no session, signed with
1334    /// the release credential, keyed by the persisted `install_id`,
1335    /// carrying no identity.
1336    ///
1337    /// Where the heartbeat is a *snapshot* (what the install looks like
1338    /// now), this is a *log* of milestones and actions (an account was
1339    /// added, a call connected, a flow answered) — the shape a setup
1340    /// funnel and a time-to-activate read need. Send at most
1341    /// [`USAGE_EVENTS_MAX_BATCH`] events per call; the platform rejects
1342    /// larger bodies. Retries are safe: each event carries a
1343    /// client-generated id the platform de-duplicates on, so a batch
1344    /// whose response was lost can be sent again verbatim.
1345    pub async fn install_usage_events_with(
1346        base_url: &str,
1347        install_id: &str,
1348        app_version: &str,
1349        cred: &ReleaseCredential,
1350        events: Vec<UsageEvent>,
1351    ) -> Result<UsageEventsResponse> {
1352        let body = UsageEventsRequest {
1353            install_id: install_id.to_string(),
1354            app_version: app_version.to_string(),
1355            events,
1356        };
1357        Client::post_public_signed_json::<UsageEventsResponse, _>(
1358            base_url,
1359            "/api/voice/installs/events",
1360            &body,
1361            cred,
1362        )
1363        .await
1364    }
1365}
1366
1367/// Upper bound on `events.len()` in one
1368/// [`Client::install_usage_events_with`] call. Mirrors the platform's
1369/// request validation; a caller with more pending events pages through
1370/// them.
1371pub const USAGE_EVENTS_MAX_BATCH: usize = 100;
1372
1373/// One anonymous usage event — a milestone or an action on an install,
1374/// stamped when it happened. See [`Client::install_usage_events_with`].
1375#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
1376#[serde(rename_all = "camelCase")]
1377pub struct UsageEvent {
1378    /// Client-generated UUID; the platform's de-duplication key, so a
1379    /// retried batch never double-counts.
1380    pub id: String,
1381    /// Event name — `snake_case`, `^[a-z][a-z0-9_]{1,63}$`. Free text by
1382    /// contract, not an enum: the platform stores whatever arrives so a
1383    /// new event can ship in the daemon without a server release. The
1384    /// daemon owns the catalogue (and its privacy page lists it).
1385    pub name: String,
1386    /// Optional qualifier from the same small vocabulary — e.g.
1387    /// `"inbound"` / `"outbound"` on a connected-call event. Same
1388    /// pattern and length rule as `name`. Never free text, never a
1389    /// number, never anything the user typed.
1390    #[serde(default, skip_serializing_if = "Option::is_none")]
1391    pub detail: Option<String>,
1392    /// ISO-8601 timestamp of when the event happened on the client —
1393    /// not when it was sent, since batches are flushed later.
1394    pub occurred_at: String,
1395}
1396
1397/// Body of `POST /api/voice/installs/events`.
1398#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
1399#[serde(rename_all = "camelCase")]
1400pub struct UsageEventsRequest {
1401    /// The daemon's persisted install UUID — the same one the heartbeat
1402    /// upserts on, so events join to `voice_installs`.
1403    pub install_id: String,
1404    /// WaveKat Voice's own version at send time.
1405    pub app_version: String,
1406    /// At most [`USAGE_EVENTS_MAX_BATCH`] entries.
1407    pub events: Vec<UsageEvent>,
1408}
1409
1410/// Response to `POST /api/voice/installs/events`.
1411#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
1412#[serde(rename_all = "camelCase")]
1413pub struct UsageEventsResponse {
1414    /// How many of the submitted events were stored for the first time.
1415    /// Less than the batch size when some ids were already known (a
1416    /// retry) — that is success, not an error.
1417    pub accepted: u32,
1418}
1419
1420// ---- Client surface for recordings ----------------------------------------
1421//
1422// Recordings don't fit the generic `Client::sync` shape cleanly:
1423//
1424//   - the response carries per-item provenance (the platform-stamped
1425//     `r2Key`, plus whether bytes have already landed) that the
1426//     daemon needs in order to decide which rows still owe a PUT;
1427//   - the bytes upload is its own HTTP call (`PUT
1428//     /api/voice/recordings/{sourceId}/bytes`), not a JSON batch.
1429//
1430// Rather than overloading `SyncEndpoint` to carry these shapes, we
1431// expose two inherent methods on `Client` that compose the existing
1432// JSON / bytes-PUT primitives.
1433
1434impl Client {
1435    /// `POST /api/voice/recordings/sync` — idempotent batch upsert of
1436    /// recording metadata. Returns the per-item `r2Key` the daemon
1437    /// should target for the follow-up bytes PUT, and whether bytes
1438    /// have already landed for each row.
1439    ///
1440    /// Batch sizing rules match [`Client::sync`]: the platform rejects
1441    /// batches over 100 items; the daemon's uploader chunks at 50.
1442    pub async fn sync_recordings(
1443        &self,
1444        items: &[VoiceRecordingRecord],
1445    ) -> Result<VoiceRecordingsSyncResponse> {
1446        let stamped = stamp_schema_version::<VoiceRecordings>(items);
1447        let body = SyncRequest { items: stamped };
1448        self.post_json::<VoiceRecordingsSyncResponse, _>("/api/voice/recordings/sync", &body)
1449            .await
1450    }
1451
1452    /// `PUT /api/voice/recordings/{sourceId}/bytes` — upload the WAV
1453    /// bytes for a recording whose metadata was previously synced via
1454    /// [`Client::sync_recordings`]. The platform refuses (`HTTP 413`)
1455    /// if `bytes.len()` disagrees with the synced `sizeBytes`.
1456    ///
1457    /// `source_id` is path-segmented as-is; callers pass the
1458    /// daemon-side UUID they used for the metadata sync. Empty /
1459    /// path-traversal-shaped ids are not specifically guarded here —
1460    /// the platform's Zod schema rejects them server-side, so a
1461    /// malformed id surfaces as a 4xx via [`Error::Http`].
1462    pub async fn upload_recording_bytes(&self, source_id: &str, bytes: Vec<u8>) -> Result<()> {
1463        if source_id.is_empty() {
1464            return Err(Error::BadRequest("source_id must not be empty".into()));
1465        }
1466        let path = format!("/api/voice/recordings/{source_id}/bytes");
1467        self.put_raw_bytes(&path, "audio/wav", bytes).await
1468    }
1469}
1470
1471// ---- Recording sharing ----------------------------------------------------
1472//
1473// Sharing is a *command* — mutate one recording's share state and get a
1474// result back — not the "batch upsert + cursor list" shape `SyncEndpoint`
1475// exists for (see wavekat-voice doc 38). So it's a typed method pair on
1476// `Client` (mirroring `whoami` rather than `sync::<E>()`), not a marker.
1477//
1478// The desktop daemon keeps only a *mirror* of what these return; the
1479// platform is authoritative for who may open a share. See
1480// `wavekat-voice/docs/38-share-a-recording.md`.
1481
1482/// Access tier for a shared recording, mirroring Loom's model. Wire-stable
1483/// snake_case strings — the platform's Zod schema validates against this
1484/// exact list, so a rename here would bounce every share command with a 400.
1485///
1486/// - `Private` — owner only (the default; "not shared").
1487/// - `Restricted` — owner + explicitly invited WaveKat accounts; the
1488///   recipient must be signed in as an invited identity ("protected by login").
1489/// - `Public` — anyone holding the capability link, no sign-in.
1490#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1491#[serde(rename_all = "snake_case")]
1492pub enum ShareVisibility {
1493    Private,
1494    Restricted,
1495    Public,
1496}
1497
1498/// How a shared recording's caller/callee identity (the call's `party`) is
1499/// exposed to a viewer. Wire-stable snake_case, matching the platform's Zod
1500/// enum, so a rename here bounces a share command with a 400.
1501///
1502/// - `Full` — hidden behind a neutral direction label ("Inbound call").
1503/// - `Partial` — best-effort redaction (keeps shape, drops the value).
1504/// - `None` — the raw `party` is shown.
1505///
1506/// Absent on the wire → the platform defaults to `Partial` (identity
1507/// masked) — privacy-forward without fully erasing the caller. See
1508/// `wavekat-platform` docs/14.
1509#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1510#[serde(rename_all = "snake_case")]
1511pub enum PartyMasking {
1512    Full,
1513    Partial,
1514    None,
1515}
1516
1517/// Body of `POST /api/voice/recordings/{id}/share` — create or update a
1518/// recording's share. The recording must already be synced (metadata +
1519/// bytes) or the platform returns 404.
1520#[derive(Debug, Clone, Serialize, Deserialize)]
1521#[serde(rename_all = "camelCase")]
1522pub struct ShareRecordingRequest {
1523    /// The artifact UUID, as synced (daemon-side `artifacts.id`). Goes in
1524    /// the URL path; carried in the struct so callers pass one value.
1525    pub recording_source_id: String,
1526    pub visibility: ShareVisibility,
1527    /// Restricted tier — the WaveKat-account emails allowed to open the
1528    /// share. Ignored (and omitted) for `Private` / `Public`.
1529    #[serde(default, skip_serializing_if = "Option::is_none")]
1530    pub invited_emails: Option<Vec<String>>,
1531    /// Per-share visibility controls (platform docs/14) — what a viewer may
1532    /// see. Each is omitted when unset; the platform then applies its
1533    /// privacy-forward default (identity masked, transcript hidden, audio
1534    /// shown, download off). NB the platform treats the request as the
1535    /// *full* desired state, so an omitted control is reset to its default,
1536    /// not preserved from a prior share — send all of them when editing an
1537    /// existing share's controls.
1538    #[serde(default, skip_serializing_if = "Option::is_none")]
1539    pub party_masking: Option<PartyMasking>,
1540    #[serde(default, skip_serializing_if = "Option::is_none")]
1541    pub show_transcript: Option<bool>,
1542    #[serde(default, skip_serializing_if = "Option::is_none")]
1543    pub show_audio: Option<bool>,
1544    /// Whether a viewer may *download* the WAV, distinct from hearing it.
1545    /// Off by default and only meaningful while `show_audio` is true — the
1546    /// platform forces it off otherwise (you can't save what you can't
1547    /// hear). A soft control: it hides the viewer's Download affordance,
1548    /// not the bytes a listener already fetches to play.
1549    #[serde(default, skip_serializing_if = "Option::is_none")]
1550    pub allow_download: Option<bool>,
1551    /// Per-channel playback defaults — which side is *audible by default*
1552    /// in the viewer's player (docs/14). A call has two channels: `local`
1553    /// (the owner's microphone, "your side") and `remote` (the other
1554    /// party, "their side"). `true` means that side starts muted; the
1555    /// viewer can still un-mute it, and the audio file is unchanged — this
1556    /// is only the player's starting state. Each is omitted when unset, in
1557    /// which case the platform defaults to audible (`false`). Only
1558    /// meaningful while `show_audio` is true; ignored when audio is hidden.
1559    #[serde(default, skip_serializing_if = "Option::is_none")]
1560    pub default_mute_local: Option<bool>,
1561    #[serde(default, skip_serializing_if = "Option::is_none")]
1562    pub default_mute_remote: Option<bool>,
1563    /// Phase 2 — out-of-band password gate. Omitted when unset.
1564    #[serde(default, skip_serializing_if = "Option::is_none")]
1565    pub password: Option<String>,
1566    /// Phase 2 — RFC 3339 auto-revoke time. Omitted when unset.
1567    #[serde(default, skip_serializing_if = "Option::is_none")]
1568    pub expires_at: Option<String>,
1569}
1570
1571/// The platform's response to a successful share command. `share_url` is
1572/// the full https link the user copies; `token` is the opaque capability
1573/// identifier embedded in it (returned separately so the daemon can store
1574/// it for display without re-parsing the URL).
1575#[derive(Debug, Clone, Serialize, Deserialize)]
1576#[serde(rename_all = "camelCase")]
1577pub struct ShareRecordingResponse {
1578    pub visibility: ShareVisibility,
1579    pub token: String,
1580    pub share_url: String,
1581    /// RFC 3339 — when the recording was first shared.
1582    pub shared_at: String,
1583    /// Effective visibility controls the platform stored (docs/14). Optional
1584    /// for tolerance — a platform predating the feature omits them, in which
1585    /// case the daemon should assume the defaults (identity masked, transcript
1586    /// hidden, audio shown, download off).
1587    #[serde(default, skip_serializing_if = "Option::is_none")]
1588    pub party_masking: Option<PartyMasking>,
1589    #[serde(default, skip_serializing_if = "Option::is_none")]
1590    pub show_transcript: Option<bool>,
1591    #[serde(default, skip_serializing_if = "Option::is_none")]
1592    pub show_audio: Option<bool>,
1593    /// Effective download permission — `show_audio && allow_download`, so
1594    /// it's never true when the audio is hidden. Absent on a platform
1595    /// predating the control (assume off).
1596    #[serde(default, skip_serializing_if = "Option::is_none")]
1597    pub allow_download: Option<bool>,
1598    /// Effective per-channel playback defaults the platform stored — which
1599    /// side starts muted in the viewer's player (docs/14). Absent on a
1600    /// platform predating the control (assume audible, `false`).
1601    #[serde(default, skip_serializing_if = "Option::is_none")]
1602    pub default_mute_local: Option<bool>,
1603    #[serde(default, skip_serializing_if = "Option::is_none")]
1604    pub default_mute_remote: Option<bool>,
1605}
1606
1607/// The platform's response to `GET /api/voice/recordings/{id}/share` — the
1608/// *authoritative* current share state for an owned recording. The POST
1609/// reply omits the invited-email list and a local mirror can't reflect a
1610/// share changed from another device, so the desktop "who can open this"
1611/// panel reads here.
1612///
1613/// A recording that was never shared (or whose share is revoked / expired)
1614/// comes back as [`ShareVisibility::Private`] with the optional fields
1615/// absent — the same "not shared" state DELETE leaves behind.
1616#[derive(Debug, Clone, Serialize, Deserialize)]
1617#[serde(rename_all = "camelCase")]
1618pub struct ShareStateResponse {
1619    pub visibility: ShareVisibility,
1620    /// Absent when `visibility == Private` (nothing is shared).
1621    #[serde(default, skip_serializing_if = "Option::is_none")]
1622    pub token: Option<String>,
1623    #[serde(default, skip_serializing_if = "Option::is_none")]
1624    pub share_url: Option<String>,
1625    /// RFC 3339 — when the recording was first shared. Absent when private.
1626    #[serde(default, skip_serializing_if = "Option::is_none")]
1627    pub shared_at: Option<String>,
1628    /// The restricted tier's audience (lowercased, de-duped). Present
1629    /// (possibly empty) only for [`ShareVisibility::Restricted`].
1630    #[serde(default, skip_serializing_if = "Option::is_none")]
1631    pub invited_emails: Option<Vec<String>>,
1632    /// Per-share visibility controls (docs/14). Present for a live share;
1633    /// absent when `Private` (nothing is shared, so no controls apply).
1634    #[serde(default, skip_serializing_if = "Option::is_none")]
1635    pub party_masking: Option<PartyMasking>,
1636    #[serde(default, skip_serializing_if = "Option::is_none")]
1637    pub show_transcript: Option<bool>,
1638    #[serde(default, skip_serializing_if = "Option::is_none")]
1639    pub show_audio: Option<bool>,
1640    /// Effective download permission — `show_audio && allow_download`, so
1641    /// never true when the audio is hidden. Absent when private.
1642    #[serde(default, skip_serializing_if = "Option::is_none")]
1643    pub allow_download: Option<bool>,
1644    /// Effective per-channel playback defaults — which side starts muted in
1645    /// the viewer's player (docs/14). Absent when private.
1646    #[serde(default, skip_serializing_if = "Option::is_none")]
1647    pub default_mute_local: Option<bool>,
1648    #[serde(default, skip_serializing_if = "Option::is_none")]
1649    pub default_mute_remote: Option<bool>,
1650}
1651
1652impl Client {
1653    /// `POST /api/voice/recordings/{id}/share` — create or update a share
1654    /// for an already-synced recording. Returns the capability link + token
1655    /// the desktop UI puts on the clipboard.
1656    ///
1657    /// Per the 404-not-403 ownership rule (doc 21 §"Authorization"), asking
1658    /// to share a recording the caller doesn't own surfaces as
1659    /// [`Error::Http`] with status 404 — existence doesn't leak.
1660    pub async fn share_recording(
1661        &self,
1662        req: &ShareRecordingRequest,
1663    ) -> Result<ShareRecordingResponse> {
1664        if req.recording_source_id.is_empty() {
1665            return Err(Error::BadRequest(
1666                "recording_source_id must not be empty".into(),
1667            ));
1668        }
1669        let path = format!("/api/voice/recordings/{}/share", req.recording_source_id);
1670        self.post_json::<ShareRecordingResponse, _>(&path, req)
1671            .await
1672    }
1673
1674    /// `GET /api/voice/recordings/{id}/share` — read the authoritative
1675    /// share state for an owned recording, including the restricted tier's
1676    /// invited emails (which the share command's reply omits). Like
1677    /// [`share_recording`](Self::share_recording), a recording the caller
1678    /// doesn't own surfaces as [`Error::Http`] with status 404.
1679    pub async fn get_recording_share(
1680        &self,
1681        recording_source_id: &str,
1682    ) -> Result<ShareStateResponse> {
1683        if recording_source_id.is_empty() {
1684            return Err(Error::BadRequest(
1685                "recording_source_id must not be empty".into(),
1686            ));
1687        }
1688        let path = format!("/api/voice/recordings/{recording_source_id}/share");
1689        self.get_json::<ShareStateResponse>(&path).await
1690    }
1691
1692    /// `DELETE /api/voice/recordings/{id}/share` — revoke the share. The
1693    /// recording reverts to Private and any outstanding link returns 410.
1694    pub async fn revoke_recording_share(&self, recording_source_id: &str) -> Result<()> {
1695        if recording_source_id.is_empty() {
1696            return Err(Error::BadRequest(
1697                "recording_source_id must not be empty".into(),
1698            ));
1699        }
1700        let path = format!("/api/voice/recordings/{recording_source_id}/share");
1701        self.delete(&path).await
1702    }
1703}
1704
1705#[cfg(test)]
1706mod tests {
1707    use super::*;
1708
1709    #[test]
1710    fn share_visibility_types_are_reachable_from_the_crate_root() {
1711        // Regression for the 0.0.13 gap: `PartyMasking` was added to this
1712        // module but left out of the crate-root `pub use voice::{…}`, and the
1713        // module is private — so a consumer (`wavekat-voice`) couldn't name
1714        // the type to build a `ShareRecordingRequest`. Pin every share-control
1715        // type to the root path so dropping one fails to compile here, not in
1716        // a downstream crate. The body never runs; reachability is the test.
1717        #[allow(dead_code)]
1718        fn _reachable() {
1719            let _: Option<crate::PartyMasking> = Some(crate::PartyMasking::Partial);
1720            let _: Option<crate::ShareVisibility> = Some(crate::ShareVisibility::Public);
1721            let _: fn(&crate::ShareRecordingRequest) = |_| {};
1722            let _: fn(&crate::ShareRecordingResponse) = |_| {};
1723        }
1724    }
1725
1726    #[test]
1727    fn record_serializes_with_camel_case_keys() {
1728        let r = VoiceCallRecord {
1729            source_id: "11111111-1111-4111-8111-111111111111".into(),
1730            account_id: "22222222-2222-4222-8222-222222222222".into(),
1731            direction: VoiceCallDirection::Inbound,
1732            party: "+14155550123".into(),
1733            ring_at: "2026-05-16T10:00:00Z".into(),
1734            answer_at: Some("2026-05-16T10:00:05Z".into()),
1735            end_at: "2026-05-16T10:01:00Z".into(),
1736            duration_ms: Some(55_000),
1737            disposition: VoiceCallDisposition::Answered,
1738            end_reason: VoiceCallEndReason::HangupRemote,
1739            error: None,
1740            share_visibility: None,
1741            transfer_target: None,
1742            codec: None,
1743            flow_id: None,
1744            flow_name: None,
1745            flow_outcome: None,
1746            flow_steps: None,
1747            deleted_at: None,
1748            envelope: SyncEnvelope::for_endpoint::<VoiceCalls>(),
1749        };
1750        let s = serde_json::to_string(&r).unwrap();
1751        assert!(s.contains("\"sourceId\":"), "{s}");
1752        assert!(s.contains("\"accountId\":"), "{s}");
1753        assert!(s.contains("\"ringAt\":"), "{s}");
1754        assert!(s.contains("\"endAt\":"), "{s}");
1755        assert!(s.contains("\"durationMs\":55000"), "{s}");
1756        // Optional `error` is None — should be omitted from the wire.
1757        assert!(!s.contains("\"error\""), "error should be omitted: {s}");
1758        // Optional `transferTarget` is None here — omitted from the wire,
1759        // exactly like a non-transferred call ships.
1760        assert!(
1761            !s.contains("\"transferTarget\""),
1762            "transferTarget should be omitted: {s}"
1763        );
1764        // Optional `codec` is None (never-answered call, or an older
1765        // daemon) — omitted from the wire, never `null`.
1766        assert!(!s.contains("\"codec\""), "codec should be omitted: {s}");
1767        // Envelope flattens to the top of the object — schemaVersion
1768        // sits next to the other fields rather than nested under
1769        // "envelope". Future resources rely on this layout.
1770        assert!(
1771            s.contains("\"schemaVersion\":1"),
1772            "schemaVersion should flatten: {s}"
1773        );
1774        // `extras` is None, so the envelope contributes no `extras`
1775        // key. Stays out of the row to keep the small/fast path.
1776        assert!(!s.contains("\"extras\""), "extras should be omitted: {s}");
1777        // A live call omits the tombstone entirely rather than sending
1778        // `null` — every ordinary sync is a live call, so this is the
1779        // common path and it should stay off the wire.
1780        assert!(
1781            !s.contains("\"deletedAt\""),
1782            "deletedAt should be omitted on a live call: {s}"
1783        );
1784    }
1785
1786    #[test]
1787    fn call_tombstone_serializes_deleted_at() {
1788        // The delete-propagation mechanism: a deleted call rides up as
1789        // an ordinary upsert with `deletedAt` set (platform docs/22),
1790        // the same shape the account tombstone uses.
1791        let mut r = VoiceCallRecord {
1792            source_id: "11111111-1111-4111-8111-111111111111".into(),
1793            account_id: "22222222-2222-4222-8222-222222222222".into(),
1794            direction: VoiceCallDirection::Inbound,
1795            party: "+14155550123".into(),
1796            ring_at: "2026-05-16T10:00:00Z".into(),
1797            answer_at: None,
1798            end_at: "2026-05-16T10:01:00Z".into(),
1799            duration_ms: None,
1800            disposition: VoiceCallDisposition::Missed,
1801            end_reason: VoiceCallEndReason::HangupRemote,
1802            error: None,
1803            share_visibility: None,
1804            transfer_target: None,
1805            codec: None,
1806            flow_id: None,
1807            flow_name: None,
1808            flow_outcome: None,
1809            flow_steps: None,
1810            deleted_at: None,
1811            envelope: SyncEnvelope::for_endpoint::<VoiceCalls>(),
1812        };
1813        r.deleted_at = Some("2026-07-30T12:00:00Z".into());
1814        let s = serde_json::to_string(&r).unwrap();
1815        assert!(s.contains("\"deletedAt\":\"2026-07-30T12:00:00Z\""), "{s}");
1816    }
1817
1818    #[test]
1819    fn call_record_parses_without_deleted_at() {
1820        // Reading back a live call from `GET /api/voice/calls`: the
1821        // platform sends `deletedAt: null`, and a platform build
1822        // predating the field sends nothing at all. Both must land as
1823        // `None` rather than failing the whole page.
1824        let raw = r#"{
1825            "sourceId": "a",
1826            "accountId": "b",
1827            "direction": "outbound",
1828            "party": "+14155550123",
1829            "ringAt": "2026-05-16T10:00:00Z",
1830            "endAt": "2026-05-16T10:01:00Z",
1831            "disposition": "answered",
1832            "endReason": "hangup_local"
1833        }"#;
1834        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1835        assert!(parsed.deleted_at.is_none());
1836
1837        let with_null: VoiceCallRecord =
1838            serde_json::from_str(&raw.replace('}', r#", "deletedAt": null }"#)).unwrap();
1839        assert!(with_null.deleted_at.is_none());
1840    }
1841
1842    #[test]
1843    fn calls_query_serializes_include_deleted() {
1844        // The delta-pull flag a device sets to learn about deletes made
1845        // elsewhere. Omitted when unset, so an ordinary list request is
1846        // unchanged.
1847        let live = VoiceCallsQuery::default();
1848        assert_eq!(serde_json::to_string(&live).unwrap(), "{}");
1849
1850        let delta = VoiceCallsQuery {
1851            include_deleted: Some(true),
1852            ..Default::default()
1853        };
1854        let s = serde_json::to_string(&delta).unwrap();
1855        assert!(s.contains("\"includeDeleted\":true"), "{s}");
1856    }
1857
1858    #[test]
1859    fn record_round_trips_optional_fields() {
1860        // An unanswered call has answer_at/duration_ms/error all absent.
1861        let raw = r#"{
1862            "sourceId": "a",
1863            "accountId": "b",
1864            "direction": "inbound",
1865            "party": "anonymous",
1866            "ringAt": "2026-05-16T10:00:00Z",
1867            "endAt": "2026-05-16T10:00:30Z",
1868            "disposition": "missed",
1869            "endReason": "missed"
1870        }"#;
1871        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1872        assert!(parsed.answer_at.is_none());
1873        assert!(parsed.duration_ms.is_none());
1874        assert!(parsed.error.is_none());
1875        assert_eq!(parsed.disposition, VoiceCallDisposition::Missed);
1876        assert_eq!(parsed.end_reason, VoiceCallEndReason::Missed);
1877    }
1878
1879    #[test]
1880    fn query_omits_unset_fields() {
1881        let q = VoiceCallsQuery::default();
1882        let s = serde_json::to_string(&q).unwrap();
1883        // Empty object — every field skipped when None.
1884        assert_eq!(
1885            s, "{}",
1886            "default query should serialize to empty object: {s}"
1887        );
1888    }
1889
1890    #[test]
1891    fn enum_round_trip_via_json() {
1892        // The wire form for each direction/disposition/reason must
1893        // match what the daemon and platform expect — this guards
1894        // against accidental Rust-side renames.
1895        for d in [VoiceCallDirection::Inbound, VoiceCallDirection::Outbound] {
1896            let s = serde_json::to_string(&d).unwrap();
1897            let back: VoiceCallDirection = serde_json::from_str(&s).unwrap();
1898            assert_eq!(d, back);
1899        }
1900        for d in [
1901            VoiceCallDisposition::Answered,
1902            VoiceCallDisposition::Missed,
1903            VoiceCallDisposition::Rejected,
1904            VoiceCallDisposition::Cancelled,
1905            VoiceCallDisposition::Failed,
1906        ] {
1907            let s = serde_json::to_string(&d).unwrap();
1908            let back: VoiceCallDisposition = serde_json::from_str(&s).unwrap();
1909            assert_eq!(d, back);
1910        }
1911        for r in [
1912            VoiceCallEndReason::HangupLocal,
1913            VoiceCallEndReason::HangupRemote,
1914            VoiceCallEndReason::RejectedLocal,
1915            VoiceCallEndReason::RejectedRemote,
1916            VoiceCallEndReason::Missed,
1917            VoiceCallEndReason::CancelledLocal,
1918            VoiceCallEndReason::TransferredLocal,
1919            VoiceCallEndReason::ConnectionLost,
1920            VoiceCallEndReason::Failed,
1921        ] {
1922            let s = serde_json::to_string(&r).unwrap();
1923            let back: VoiceCallEndReason = serde_json::from_str(&s).unwrap();
1924            assert_eq!(r, back);
1925        }
1926    }
1927
1928    #[test]
1929    fn connection_lost_pins_its_wire_string() {
1930        // The platform's sync endpoint validates end reasons against
1931        // an exact string list — a rename here would make every
1932        // upload from a session-timer teardown bounce with a 400.
1933        let s = serde_json::to_string(&VoiceCallEndReason::ConnectionLost).unwrap();
1934        assert_eq!(s, "\"connection_lost\"");
1935    }
1936
1937    #[test]
1938    fn transferred_local_pins_its_wire_string() {
1939        // Same contract as `connection_lost`: the platform validates
1940        // against an exact string list, so a rename here would bounce
1941        // every transferred-call upload with a 400.
1942        let s = serde_json::to_string(&VoiceCallEndReason::TransferredLocal).unwrap();
1943        assert_eq!(s, "\"transferred_local\"");
1944    }
1945
1946    #[test]
1947    fn record_round_trips_transfer_target() {
1948        // A transferred call carries `transferTarget` both ways — the
1949        // daemon ships it (it's its own data, not read-only decoration),
1950        // and the platform echoes it back on read.
1951        let raw = r#"{
1952            "sourceId": "a",
1953            "accountId": "b",
1954            "direction": "inbound",
1955            "party": "Alice <sip:alice@example.com>",
1956            "ringAt": "2026-06-28T10:00:00Z",
1957            "answerAt": "2026-06-28T10:00:05Z",
1958            "endAt": "2026-06-28T10:00:30Z",
1959            "durationMs": 25000,
1960            "disposition": "answered",
1961            "endReason": "transferred_local",
1962            "transferTarget": "1002"
1963        }"#;
1964        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
1965        assert_eq!(parsed.end_reason, VoiceCallEndReason::TransferredLocal);
1966        assert_eq!(parsed.transfer_target.as_deref(), Some("1002"));
1967        // And it survives a re-serialize (daemon → platform direction).
1968        let s = serde_json::to_string(&parsed).unwrap();
1969        assert!(s.contains("\"transferTarget\":\"1002\""), "{s}");
1970    }
1971
1972    #[test]
1973    fn codec_pins_its_wire_strings() {
1974        // The platform's sync endpoint validates the codec against an
1975        // exact string list, and the daemon's `CallCodec::as_str` emits
1976        // these same strings — a rename here would bounce every upload
1977        // from an answered call with a 400.
1978        for (codec, wire) in [
1979            (VoiceCallCodec::Opus, "\"opus\""),
1980            (VoiceCallCodec::Pcmu, "\"pcmu\""),
1981            (VoiceCallCodec::Pcma, "\"pcma\""),
1982        ] {
1983            assert_eq!(serde_json::to_string(&codec).unwrap(), wire);
1984            let back: VoiceCallCodec = serde_json::from_str(wire).unwrap();
1985            assert_eq!(back, codec);
1986        }
1987    }
1988
1989    #[test]
1990    fn record_round_trips_codec() {
1991        // An answered call carries `codec` both ways — the daemon ships
1992        // it (its own data, like transferTarget), and the platform
1993        // echoes it back on read so the website can show the call's
1994        // audio quality.
1995        let raw = r#"{
1996            "sourceId": "a",
1997            "accountId": "b",
1998            "direction": "inbound",
1999            "party": "Alice <sip:alice@example.com>",
2000            "ringAt": "2026-07-03T10:00:00Z",
2001            "answerAt": "2026-07-03T10:00:05Z",
2002            "endAt": "2026-07-03T10:00:30Z",
2003            "durationMs": 25000,
2004            "disposition": "answered",
2005            "endReason": "hangup_remote",
2006            "codec": "opus"
2007        }"#;
2008        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2009        assert_eq!(parsed.codec, Some(VoiceCallCodec::Opus));
2010        // And it survives a re-serialize (daemon → platform direction).
2011        let s = serde_json::to_string(&parsed).unwrap();
2012        assert!(s.contains("\"codec\":\"opus\""), "{s}");
2013
2014        // A row from an older daemon has no codec — reads as None.
2015        let legacy = raw.replace(",\n            \"codec\": \"opus\"", "");
2016        let parsed: VoiceCallRecord = serde_json::from_str(&legacy).unwrap();
2017        assert_eq!(parsed.codec, None);
2018    }
2019
2020    #[test]
2021    fn flow_outcome_pins_its_wire_strings() {
2022        // Three parties agree on these exact strings: the daemon's
2023        // `flow_outcome_to_str`, `wavekat_flow::trace::FlowOutcome`'s
2024        // snake_case serde, and the platform's zod enum. A rename here
2025        // 400s every flow-answered call's batch.
2026        for (outcome, wire) in [
2027            (VoiceCallFlowOutcome::Answered, "\"answered\""),
2028            (VoiceCallFlowOutcome::MessageLeft, "\"message_left\""),
2029            (VoiceCallFlowOutcome::Transferred, "\"transferred\""),
2030            (VoiceCallFlowOutcome::HungUp, "\"hung_up\""),
2031            (VoiceCallFlowOutcome::Aborted, "\"aborted\""),
2032            (VoiceCallFlowOutcome::Defect, "\"defect\""),
2033        ] {
2034            assert_eq!(serde_json::to_string(&outcome).unwrap(), wire);
2035            let back: VoiceCallFlowOutcome = serde_json::from_str(wire).unwrap();
2036            assert_eq!(back, outcome);
2037        }
2038    }
2039
2040    #[test]
2041    fn record_round_trips_flow_attribution() {
2042        // A flow-answered call carries which flow took it and how the
2043        // run ended, both ways: the daemon ships them, the platform
2044        // echoes them so the website can say "Answered by “X”" and show
2045        // the run's own outcome instead of the misleading SIP one.
2046        let raw = r#"{
2047            "sourceId": "a",
2048            "accountId": "b",
2049            "direction": "inbound",
2050            "party": "Alice <sip:alice@example.com>",
2051            "ringAt": "2026-07-03T10:00:00Z",
2052            "answerAt": "2026-07-03T10:00:05Z",
2053            "endAt": "2026-07-03T10:00:30Z",
2054            "durationMs": 25000,
2055            "disposition": "answered",
2056            "endReason": "hangup_local",
2057            "flowId": "flow_after_hours",
2058            "flowName": "After hours",
2059            "flowOutcome": "message_left"
2060        }"#;
2061        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2062        assert_eq!(parsed.flow_id.as_deref(), Some("flow_after_hours"));
2063        assert_eq!(parsed.flow_name.as_deref(), Some("After hours"));
2064        assert_eq!(parsed.flow_outcome, Some(VoiceCallFlowOutcome::MessageLeft));
2065
2066        let s = serde_json::to_string(&parsed).unwrap();
2067        assert!(s.contains("\"flowId\":\"flow_after_hours\""), "{s}");
2068        assert!(s.contains("\"flowName\":\"After hours\""), "{s}");
2069        assert!(s.contains("\"flowOutcome\":\"message_left\""), "{s}");
2070    }
2071
2072    #[test]
2073    fn record_round_trips_a_flow_step_trace() {
2074        // Pins the per-step field names. These are consumed by the
2075        // platform's Zod schema on one side and produced by the daemon's
2076        // projection on the other; a silent rename here breaks both.
2077        let raw = r#"{
2078            "sourceId": "a",
2079            "accountId": "b",
2080            "direction": "inbound",
2081            "party": "sip:alice@example.com",
2082            "ringAt": "2026-07-03T10:00:00Z",
2083            "answerAt": "2026-07-03T10:00:05Z",
2084            "endAt": "2026-07-03T10:00:30Z",
2085            "disposition": "answered",
2086            "endReason": "hangup_local",
2087            "flowId": "f",
2088            "flowName": "F",
2089            "flowSteps": [
2090                { "atMs": 0, "kind": "spoke", "node": "greeting" },
2091                { "atMs": 4200, "kind": "menu_choice", "digit": "2" },
2092                { "atMs": 9100, "kind": "message_recorded", "secs": 31 }
2093            ]
2094        }"#;
2095        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2096        let steps = parsed.flow_steps.as_deref().expect("steps present");
2097        assert_eq!(steps.len(), 3);
2098        assert_eq!(steps[1].kind, "menu_choice");
2099        assert_eq!(steps[1].digit.as_deref(), Some("2"));
2100        assert_eq!(steps[2].secs, Some(31));
2101        // Absent per-step fields stay absent rather than serializing as
2102        // nulls — same contract as the record's own optional fields.
2103        let s = serde_json::to_string(&steps[0]).unwrap();
2104        assert_eq!(s, r#"{"atMs":0,"kind":"spoke","node":"greeting"}"#);
2105    }
2106
2107    #[test]
2108    fn flow_step_accepts_a_kind_this_build_does_not_know() {
2109        // The whole reason `kind` is a String. A consumer pinned to an
2110        // older crate version must still deserialize a newer daemon's
2111        // trace — rejecting would fail the entire call record, not one
2112        // step.
2113        let step: VoiceCallFlowStep =
2114            serde_json::from_str(r#"{"atMs": 10, "kind": "consulted_the_oracle"}"#).unwrap();
2115        assert_eq!(step.kind, "consulted_the_oracle");
2116        assert_eq!(step.digit, None);
2117    }
2118
2119    #[test]
2120    fn record_omits_flow_steps_for_a_human_answered_call() {
2121        // A call the user took themselves has no trace. The field must
2122        // stay off the wire entirely rather than serializing as null.
2123        let raw = r#"{
2124            "sourceId": "a",
2125            "accountId": "b",
2126            "direction": "inbound",
2127            "party": "sip:alice@example.com",
2128            "ringAt": "2026-07-03T10:00:00Z",
2129            "endAt": "2026-07-03T10:00:30Z",
2130            "disposition": "answered",
2131            "endReason": "hangup_local"
2132        }"#;
2133        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2134        assert!(parsed.flow_steps.is_none());
2135        let s = serde_json::to_string(&parsed).unwrap();
2136        assert!(!s.contains("flowSteps"), "{s}");
2137    }
2138
2139    #[test]
2140    fn record_omits_flow_fields_for_a_human_answered_call() {
2141        // Calls the user took themselves — and every row from a daemon
2142        // predating call flows — carry none of the three. They must
2143        // stay off the wire entirely, not serialize as nulls.
2144        let raw = r#"{
2145            "sourceId": "a",
2146            "accountId": "b",
2147            "direction": "inbound",
2148            "party": "sip:alice@example.com",
2149            "ringAt": "2026-07-03T10:00:00Z",
2150            "endAt": "2026-07-03T10:00:30Z",
2151            "disposition": "answered",
2152            "endReason": "hangup_remote"
2153        }"#;
2154        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2155        assert_eq!(parsed.flow_id, None);
2156        assert_eq!(parsed.flow_name, None);
2157        assert_eq!(parsed.flow_outcome, None);
2158
2159        let s = serde_json::to_string(&parsed).unwrap();
2160        assert!(!s.contains("\"flowId\""), "flowId should be omitted: {s}");
2161        assert!(
2162            !s.contains("\"flowName\""),
2163            "flowName should be omitted: {s}"
2164        );
2165        assert!(
2166            !s.contains("\"flowOutcome\""),
2167            "flowOutcome should be omitted: {s}"
2168        );
2169    }
2170
2171    #[test]
2172    fn voice_calls_marker_resource_is_calls() {
2173        assert_eq!(<VoiceCalls as SyncEndpoint>::RESOURCE, "calls");
2174    }
2175
2176    #[test]
2177    fn record_accepts_unknown_extras_for_forward_compat() {
2178        // A newer client shipping a `notes` field that this platform
2179        // version doesn't have a column for should round-trip via
2180        // the `extras` envelope. The platform persists the blob
2181        // verbatim; a future deploy can promote it to a typed
2182        // column without data loss.
2183        let raw = r#"{
2184            "sourceId": "a",
2185            "accountId": "b",
2186            "direction": "inbound",
2187            "party": "anon",
2188            "ringAt": "2026-05-16T10:00:00Z",
2189            "endAt": "2026-05-16T10:00:30Z",
2190            "disposition": "answered",
2191            "endReason": "hangup_remote",
2192            "schemaVersion": 2,
2193            "extras": { "notes": "from staging build" }
2194        }"#;
2195        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2196        assert_eq!(parsed.envelope.schema_version, Some(2));
2197        let extras = parsed.envelope.extras.as_ref().expect("extras present");
2198        assert_eq!(extras["notes"], "from staging build");
2199    }
2200
2201    #[test]
2202    fn call_record_parses_share_visibility_from_list_response() {
2203        // The list / detail endpoints decorate a call with the tier of any
2204        // active share on its recording, so a consumer can badge the row.
2205        let raw = r#"{
2206            "sourceId": "a",
2207            "accountId": "b",
2208            "direction": "outbound",
2209            "party": "+14155550123",
2210            "ringAt": "2026-05-16T10:00:00Z",
2211            "endAt": "2026-05-16T10:00:30Z",
2212            "disposition": "answered",
2213            "endReason": "hangup_remote",
2214            "shareVisibility": "public"
2215        }"#;
2216        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2217        assert_eq!(parsed.share_visibility, Some(ShareVisibility::Public));
2218
2219        let restricted = raw.replace("public", "restricted");
2220        let parsed: VoiceCallRecord = serde_json::from_str(&restricted).unwrap();
2221        assert_eq!(parsed.share_visibility, Some(ShareVisibility::Restricted));
2222    }
2223
2224    #[test]
2225    fn call_record_unshared_has_no_share_visibility() {
2226        // Absent (older platform, or an unshared call) and an explicit
2227        // `null` both read as "not shared" — never `Some(Private)`.
2228        let base = r#"{
2229            "sourceId": "a",
2230            "accountId": "b",
2231            "direction": "inbound",
2232            "party": "anon",
2233            "ringAt": "2026-05-16T10:00:00Z",
2234            "endAt": "2026-05-16T10:00:30Z",
2235            "disposition": "missed",
2236            "endReason": "missed"
2237        }"#;
2238        let parsed: VoiceCallRecord = serde_json::from_str(base).unwrap();
2239        assert_eq!(parsed.share_visibility, None);
2240
2241        let with_null = base.replace(
2242            r#""endReason": "missed""#,
2243            r#""endReason": "missed", "shareVisibility": null"#,
2244        );
2245        let parsed: VoiceCallRecord = serde_json::from_str(&with_null).unwrap();
2246        assert_eq!(parsed.share_visibility, None);
2247    }
2248
2249    #[test]
2250    fn synced_call_omits_share_visibility() {
2251        // `share_visibility` is read-only decoration: a call uploaded via
2252        // sync must not carry it on the wire (skip_serializing_if = None),
2253        // so the round trip from a sync-shaped record stays clean.
2254        let raw = r#"{
2255            "sourceId": "a",
2256            "accountId": "b",
2257            "direction": "inbound",
2258            "party": "anon",
2259            "ringAt": "2026-05-16T10:00:00Z",
2260            "endAt": "2026-05-16T10:00:30Z",
2261            "disposition": "answered",
2262            "endReason": "hangup_remote"
2263        }"#;
2264        let parsed: VoiceCallRecord = serde_json::from_str(raw).unwrap();
2265        assert_eq!(parsed.share_visibility, None);
2266        let s = serde_json::to_string(&parsed).unwrap();
2267        assert!(
2268            !s.contains("shareVisibility"),
2269            "sync payload leaked share_visibility: {s}"
2270        );
2271    }
2272
2273    #[test]
2274    fn recording_marker_resource_is_recordings() {
2275        // Path constant drives the URL in `Client::sync_recordings`;
2276        // a rename here would silently 404 against the platform.
2277        assert_eq!(<VoiceRecordings as SyncEndpoint>::RESOURCE, "recordings");
2278    }
2279
2280    #[test]
2281    fn recording_record_serializes_with_camel_case_and_envelope() {
2282        let r = VoiceRecordingRecord {
2283            source_id: "11111111-1111-4111-8111-111111111111".into(),
2284            call_source_id: "22222222-2222-4222-8222-222222222222".into(),
2285            size_bytes: 44 + 64_000,
2286            duration_ms: 2_000,
2287            sample_rate: 8_000,
2288            channels: 2,
2289            created_at: "2026-05-16T10:01:05Z".into(),
2290            envelope: SyncEnvelope::for_endpoint::<VoiceRecordings>(),
2291        };
2292        let s = serde_json::to_string(&r).unwrap();
2293        // Field-by-field wire contract — these strings are also what
2294        // the platform's Zod schema expects.
2295        assert!(s.contains("\"sourceId\":"), "{s}");
2296        assert!(s.contains("\"callSourceId\":"), "{s}");
2297        assert!(s.contains("\"sizeBytes\":64044"), "{s}");
2298        assert!(s.contains("\"durationMs\":2000"), "{s}");
2299        assert!(s.contains("\"sampleRate\":8000"), "{s}");
2300        assert!(s.contains("\"channels\":2"), "{s}");
2301        assert!(s.contains("\"createdAt\":"), "{s}");
2302        // Envelope flattens to the top of the object, same as VoiceCallRecord.
2303        assert!(s.contains("\"schemaVersion\":1"), "{s}");
2304    }
2305
2306    #[test]
2307    fn recordings_sync_response_round_trips() {
2308        // The richer-than-generic response carries per-item provenance —
2309        // the daemon's uploader reads `r2Key` for the bytes follow-up
2310        // and `bytesUploaded` to short-circuit when the row already
2311        // landed on a previous cycle.
2312        let raw = r#"{
2313            "accepted": 2,
2314            "skipped": 0,
2315            "items": [
2316                {"sourceId": "a", "r2Key": "voice/recordings/1/a.wav", "bytesUploaded": false},
2317                {"sourceId": "b", "r2Key": "voice/recordings/1/b.wav", "bytesUploaded": true}
2318            ]
2319        }"#;
2320        let parsed: VoiceRecordingsSyncResponse = serde_json::from_str(raw).unwrap();
2321        assert_eq!(parsed.accepted, 2);
2322        assert_eq!(parsed.items.len(), 2);
2323        assert_eq!(parsed.items[0].r2_key, "voice/recordings/1/a.wav");
2324        assert!(!parsed.items[0].bytes_uploaded);
2325        assert!(parsed.items[1].bytes_uploaded);
2326    }
2327
2328    #[test]
2329    fn install_heartbeat_request_serializes_with_camel_case_keys() {
2330        let req = InstallHeartbeatRequest {
2331            install_id: "11111111-1111-4111-8111-111111111111".into(),
2332            app_version: "0.0.21".into(),
2333            os: "macos".into(),
2334            os_version: Some("15.5.0".into()),
2335            arch: Some("aarch64".into()),
2336            locale: Some("en-NZ".into()),
2337            distribution: Some("mas".into()),
2338            fleet: InstallHeartbeatFleet::default(),
2339        };
2340        let s = serde_json::to_string(&req).unwrap();
2341        assert!(s.contains("\"installId\":"), "{s}");
2342        assert!(s.contains("\"appVersion\":\"0.0.21\""), "{s}");
2343        assert!(s.contains("\"os\":\"macos\""), "{s}");
2344        assert!(s.contains("\"osVersion\":\"15.5.0\""), "{s}");
2345        assert!(s.contains("\"arch\":\"aarch64\""), "{s}");
2346        assert!(s.contains("\"locale\":\"en-NZ\""), "{s}");
2347        assert!(s.contains("\"distribution\":\"mas\""), "{s}");
2348    }
2349
2350    #[test]
2351    fn install_heartbeat_request_omits_absent_optional_fields() {
2352        // A host where the OS version / locale probe came up empty
2353        // shouldn't send `null` — keeping the keys out lets the
2354        // platform's Zod `.optional()` accept the body and the column
2355        // stay NULL rather than the string "null".
2356        let req = InstallHeartbeatRequest {
2357            install_id: "x".into(),
2358            app_version: "0.0.21".into(),
2359            os: "linux".into(),
2360            os_version: None,
2361            arch: None,
2362            locale: None,
2363            distribution: None,
2364            fleet: InstallHeartbeatFleet::default(),
2365        };
2366        let s = serde_json::to_string(&req).unwrap();
2367        assert!(!s.contains("osVersion"), "osVersion should be omitted: {s}");
2368        assert!(!s.contains("arch"), "arch should be omitted: {s}");
2369        assert!(!s.contains("locale"), "locale should be omitted: {s}");
2370        assert!(
2371            !s.contains("distribution"),
2372            "distribution should be omitted: {s}"
2373        );
2374    }
2375
2376    #[test]
2377    fn install_heartbeat_request_with_default_fleet_matches_pre_fleet_key_set() {
2378        // `fleet: InstallHeartbeatFleet::default()` (all `None`) must
2379        // serialize to exactly the key set the platform saw before this
2380        // struct existed — flatten + `skip_serializing_if` must not
2381        // leak an empty-object marker or any of the ten new keys.
2382        let req = InstallHeartbeatRequest {
2383            install_id: "11111111-1111-4111-8111-111111111111".into(),
2384            app_version: "0.0.21".into(),
2385            os: "macos".into(),
2386            os_version: Some("15.5.0".into()),
2387            arch: Some("aarch64".into()),
2388            locale: Some("en-NZ".into()),
2389            distribution: Some("mas".into()),
2390            fleet: InstallHeartbeatFleet::default(),
2391        };
2392        let value: serde_json::Value = serde_json::to_value(&req).unwrap();
2393        let mut keys: Vec<&str> = value
2394            .as_object()
2395            .unwrap()
2396            .keys()
2397            .map(String::as_str)
2398            .collect();
2399        keys.sort_unstable();
2400        let mut expected = vec![
2401            "installId",
2402            "appVersion",
2403            "os",
2404            "osVersion",
2405            "arch",
2406            "locale",
2407            "distribution",
2408        ];
2409        expected.sort_unstable();
2410        assert_eq!(keys, expected, "unexpected key set: {value}");
2411    }
2412
2413    #[test]
2414    fn install_heartbeat_request_with_full_fleet_serializes_camel_case() {
2415        let req = InstallHeartbeatRequest {
2416            install_id: "11111111-1111-4111-8111-111111111111".into(),
2417            app_version: "0.0.21".into(),
2418            os: "macos".into(),
2419            os_version: Some("15.5.0".into()),
2420            arch: Some("aarch64".into()),
2421            locale: Some("en-NZ".into()),
2422            distribution: Some("mas".into()),
2423            fleet: InstallHeartbeatFleet {
2424                build_sha: Some("deadbeef".into()),
2425                install_source: Some("mas".into()),
2426                update_channel: Some("stable".into()),
2427                updater_enabled: Some(false),
2428                updater_status: Some("idle".into()),
2429                updater_version: Some("0.0.22".into()),
2430                updater_checked_at: Some("2026-09-07T10:00:00.000Z".into()),
2431                updater_error: Some("network timeout".into()),
2432                native_arch: Some("arm64".into()),
2433                started_at: Some("2026-09-07T09:00:00.000Z".into()),
2434                flow_armed: Some(true),
2435            },
2436        };
2437        let value: serde_json::Value = serde_json::to_value(&req).unwrap();
2438        assert_eq!(value["buildSha"], "deadbeef");
2439        assert_eq!(value["installSource"], "mas");
2440        assert_eq!(value["updateChannel"], "stable");
2441        assert_eq!(value["updaterEnabled"], serde_json::json!(false));
2442        assert!(value["updaterEnabled"].is_boolean(), "{value}");
2443        assert_eq!(value["updaterStatus"], "idle");
2444        assert_eq!(value["updaterVersion"], "0.0.22");
2445        assert_eq!(value["updaterCheckedAt"], "2026-09-07T10:00:00.000Z");
2446        assert_eq!(value["updaterError"], "network timeout");
2447        assert_eq!(value["nativeArch"], "arm64");
2448        assert_eq!(value["startedAt"], "2026-09-07T09:00:00.000Z");
2449        assert_eq!(value["flowArmed"], serde_json::json!(true));
2450        assert!(value["flowArmed"].is_boolean(), "{value}");
2451    }
2452
2453    #[test]
2454    fn install_heartbeat_request_full_fleet_round_trips() {
2455        let req = InstallHeartbeatRequest {
2456            install_id: "11111111-1111-4111-8111-111111111111".into(),
2457            app_version: "0.0.21".into(),
2458            os: "macos".into(),
2459            os_version: Some("15.5.0".into()),
2460            arch: Some("aarch64".into()),
2461            locale: Some("en-NZ".into()),
2462            distribution: Some("mas".into()),
2463            fleet: InstallHeartbeatFleet {
2464                build_sha: Some("deadbeef".into()),
2465                install_source: Some("mas".into()),
2466                update_channel: Some("stable".into()),
2467                updater_enabled: Some(false),
2468                updater_status: Some("idle".into()),
2469                updater_version: Some("0.0.22".into()),
2470                updater_checked_at: Some("2026-09-07T10:00:00.000Z".into()),
2471                updater_error: Some("network timeout".into()),
2472                native_arch: Some("arm64".into()),
2473                started_at: Some("2026-09-07T09:00:00.000Z".into()),
2474                flow_armed: Some(true),
2475            },
2476        };
2477        let s = serde_json::to_string(&req).unwrap();
2478        let round_tripped: InstallHeartbeatRequest = serde_json::from_str(&s).unwrap();
2479        assert_eq!(round_tripped, req);
2480    }
2481
2482    #[test]
2483    fn install_heartbeat_request_without_fleet_keys_deserializes_to_default_fleet() {
2484        // A body from a daemon that predates the fleet fields (or one
2485        // that simply has nothing to report) carries none of the eleven
2486        // fleet keys. It must still parse, with `fleet` coming back as
2487        // the all-`None` default.
2488        let raw = r#"{
2489            "installId": "11111111-1111-4111-8111-111111111111",
2490            "appVersion": "0.0.21",
2491            "os": "macos",
2492            "osVersion": "15.5.0",
2493            "arch": "aarch64",
2494            "locale": "en-NZ",
2495            "distribution": "mas"
2496        }"#;
2497        let parsed: InstallHeartbeatRequest = serde_json::from_str(raw).unwrap();
2498        assert_eq!(parsed.fleet, InstallHeartbeatFleet::default());
2499    }
2500
2501    #[test]
2502    fn usage_events_request_serializes_camel_case_and_omits_absent_detail() {
2503        let req = UsageEventsRequest {
2504            install_id: "11111111-1111-4111-8111-111111111111".into(),
2505            app_version: "0.0.53".into(),
2506            events: vec![
2507                UsageEvent {
2508                    id: "22222222-2222-4222-8222-222222222222".into(),
2509                    name: "account_added".into(),
2510                    detail: None,
2511                    occurred_at: "2026-09-08T09:00:00.000Z".into(),
2512                },
2513                UsageEvent {
2514                    id: "33333333-3333-4333-8333-333333333333".into(),
2515                    name: "call_connected".into(),
2516                    detail: Some("inbound".into()),
2517                    occurred_at: "2026-09-08T09:05:00.000Z".into(),
2518                },
2519            ],
2520        };
2521        let value: serde_json::Value = serde_json::to_value(&req).unwrap();
2522        assert_eq!(value["installId"], "11111111-1111-4111-8111-111111111111");
2523        assert_eq!(value["appVersion"], "0.0.53");
2524        let events = value["events"].as_array().unwrap();
2525        assert_eq!(events.len(), 2);
2526        assert_eq!(events[0]["name"], "account_added");
2527        assert_eq!(events[0]["occurredAt"], "2026-09-08T09:00:00.000Z");
2528        assert!(
2529            events[0].get("detail").is_none(),
2530            "absent detail must be omitted, not null: {value}"
2531        );
2532        assert_eq!(events[1]["detail"], "inbound");
2533    }
2534
2535    #[test]
2536    fn usage_events_request_round_trips() {
2537        let req = UsageEventsRequest {
2538            install_id: "11111111-1111-4111-8111-111111111111".into(),
2539            app_version: "0.0.53".into(),
2540            events: vec![UsageEvent {
2541                id: "22222222-2222-4222-8222-222222222222".into(),
2542                name: "flow_answered".into(),
2543                detail: Some("message_left".into()),
2544                occurred_at: "2026-09-08T09:00:00.000Z".into(),
2545            }],
2546        };
2547        let s = serde_json::to_string(&req).unwrap();
2548        let back: UsageEventsRequest = serde_json::from_str(&s).unwrap();
2549        assert_eq!(back, req);
2550    }
2551
2552    #[test]
2553    fn usage_events_response_parses_platform_shape() {
2554        let parsed: UsageEventsResponse = serde_json::from_str(r#"{"accepted":2}"#).unwrap();
2555        assert_eq!(parsed.accepted, 2);
2556    }
2557
2558    #[test]
2559    fn install_heartbeat_response_parses_platform_shape() {
2560        let raw = r#"{
2561            "id": "abc-123",
2562            "installId": "11111111-1111-4111-8111-111111111111",
2563            "appVersion": "0.0.21",
2564            "os": "macos",
2565            "osVersion": "15.5.0",
2566            "arch": "aarch64",
2567            "locale": null,
2568            "firstSeenAt": "2026-05-31T10:00:00.000Z",
2569            "lastSeenAt": "2026-05-31T10:00:00.000Z"
2570        }"#;
2571        let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2572        assert_eq!(parsed.id, "abc-123");
2573        assert_eq!(parsed.app_version, "0.0.21");
2574        assert_eq!(parsed.os_version.as_deref(), Some("15.5.0"));
2575        assert!(parsed.locale.is_none());
2576        // The fixture above carries no `distribution` key at all, which
2577        // is what a platform deployed before the field looks like. It
2578        // must parse, not error — hence `#[serde(default)]`.
2579        assert!(parsed.distribution.is_none());
2580    }
2581
2582    #[test]
2583    fn install_heartbeat_response_reads_the_distribution_back() {
2584        let raw = r#"{
2585            "id": "abc-123",
2586            "installId": "11111111-1111-4111-8111-111111111111",
2587            "appVersion": "0.0.48",
2588            "os": "macos",
2589            "osVersion": "15.5.0",
2590            "arch": "aarch64",
2591            "locale": "en-NZ",
2592            "distribution": "mas",
2593            "firstSeenAt": "2026-08-22T10:00:00.000Z",
2594            "lastSeenAt": "2026-08-22T10:00:00.000Z"
2595        }"#;
2596        let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2597        assert_eq!(parsed.distribution.as_deref(), Some("mas"));
2598    }
2599
2600    #[test]
2601    fn install_heartbeat_response_accepts_an_unknown_distribution() {
2602        // Free text by contract: the platform stores whatever arrives so
2603        // a new distribution can ship without a server release. Parsing
2604        // it into an enum here would undo that on the client side.
2605        let raw = r#"{
2606            "id": "abc-123",
2607            "installId": "11111111-1111-4111-8111-111111111111",
2608            "appVersion": "0.1.0",
2609            "os": "windows",
2610            "osVersion": null,
2611            "arch": "x86_64",
2612            "locale": null,
2613            "distribution": "msstore",
2614            "firstSeenAt": "2026-08-22T10:00:00.000Z",
2615            "lastSeenAt": "2026-08-22T10:00:00.000Z"
2616        }"#;
2617        let parsed: InstallHeartbeatResponse = serde_json::from_str(raw).unwrap();
2618        assert_eq!(parsed.distribution.as_deref(), Some("msstore"));
2619    }
2620
2621    #[test]
2622    fn system_info_detect_fills_os_and_arch() {
2623        // os / arch come from compile-time consts, so they're always
2624        // non-empty on every supported target. os_version / locale are
2625        // best-effort and intentionally not asserted.
2626        let sys = SystemInfo::detect();
2627        assert!(!sys.os.is_empty(), "os should be a non-empty target string");
2628        assert!(
2629            !sys.arch.is_empty(),
2630            "arch should be a non-empty target string"
2631        );
2632    }
2633
2634    #[test]
2635    fn transcripts_marker_resource_is_transcripts() {
2636        assert_eq!(<VoiceTranscripts as SyncEndpoint>::RESOURCE, "transcripts");
2637    }
2638
2639    #[test]
2640    fn transcript_record_serializes_with_camel_case_and_channel_enum() {
2641        let r = VoiceTranscriptRecord {
2642            source_id: "1".into(),
2643            call_source_id: "22222222-2222-4222-8222-222222222222".into(),
2644            channel: VoiceTranscriptChannel::Remote,
2645            ts_ms: 100,
2646            end_ms: 1_500,
2647            text: "hello".into(),
2648            envelope: SyncEnvelope::for_endpoint::<VoiceTranscripts>(),
2649        };
2650        let s = serde_json::to_string(&r).unwrap();
2651        assert!(s.contains("\"sourceId\":"), "{s}");
2652        assert!(s.contains("\"callSourceId\":"), "{s}");
2653        // The channel enum is wire-stable snake_case — matches the
2654        // platform's Zod `enum(VOICE_TRANSCRIPT_CHANNELS)`.
2655        assert!(s.contains("\"channel\":\"remote\""), "{s}");
2656        assert!(s.contains("\"tsMs\":100"), "{s}");
2657        assert!(s.contains("\"endMs\":1500"), "{s}");
2658        assert!(s.contains("\"text\":\"hello\""), "{s}");
2659        assert!(s.contains("\"schemaVersion\":1"), "{s}");
2660    }
2661
2662    #[test]
2663    fn share_visibility_pins_its_wire_strings() {
2664        // The platform validates these against an exact string list; a
2665        // rename would bounce every share command with a 400.
2666        assert_eq!(
2667            serde_json::to_string(&ShareVisibility::Private).unwrap(),
2668            "\"private\""
2669        );
2670        assert_eq!(
2671            serde_json::to_string(&ShareVisibility::Restricted).unwrap(),
2672            "\"restricted\""
2673        );
2674        assert_eq!(
2675            serde_json::to_string(&ShareVisibility::Public).unwrap(),
2676            "\"public\""
2677        );
2678        for v in [
2679            ShareVisibility::Private,
2680            ShareVisibility::Restricted,
2681            ShareVisibility::Public,
2682        ] {
2683            let s = serde_json::to_string(&v).unwrap();
2684            let back: ShareVisibility = serde_json::from_str(&s).unwrap();
2685            assert_eq!(v, back);
2686        }
2687    }
2688
2689    #[test]
2690    fn share_request_serializes_with_camel_case_and_omits_unset() {
2691        let req = ShareRecordingRequest {
2692            recording_source_id: "11111111-1111-4111-8111-111111111111".into(),
2693            visibility: ShareVisibility::Public,
2694            invited_emails: None,
2695            party_masking: None,
2696            show_transcript: None,
2697            show_audio: None,
2698            allow_download: None,
2699            default_mute_local: None,
2700            default_mute_remote: None,
2701            password: None,
2702            expires_at: None,
2703        };
2704        let s = serde_json::to_string(&req).unwrap();
2705        assert!(s.contains("\"recordingSourceId\":"), "{s}");
2706        assert!(s.contains("\"visibility\":\"public\""), "{s}");
2707        // Phase-2 / tier-specific / visibility-control fields stay off the
2708        // wire when unset so the platform's `.optional()` schema accepts the
2709        // body (and the omitted controls fall to the platform defaults).
2710        assert!(!s.contains("invitedEmails"), "{s}");
2711        assert!(!s.contains("partyMasking"), "{s}");
2712        assert!(!s.contains("showTranscript"), "{s}");
2713        assert!(!s.contains("showAudio"), "{s}");
2714        assert!(!s.contains("allowDownload"), "{s}");
2715        assert!(!s.contains("defaultMuteLocal"), "{s}");
2716        assert!(!s.contains("defaultMuteRemote"), "{s}");
2717        assert!(!s.contains("password"), "{s}");
2718        assert!(!s.contains("expiresAt"), "{s}");
2719    }
2720
2721    #[test]
2722    fn share_request_serializes_visibility_controls_camel_case() {
2723        let req = ShareRecordingRequest {
2724            recording_source_id: "a".into(),
2725            visibility: ShareVisibility::Public,
2726            invited_emails: None,
2727            party_masking: Some(PartyMasking::Partial),
2728            show_transcript: Some(false),
2729            show_audio: Some(true),
2730            allow_download: Some(true),
2731            default_mute_local: Some(false),
2732            default_mute_remote: Some(true),
2733            password: None,
2734            expires_at: None,
2735        };
2736        let s = serde_json::to_string(&req).unwrap();
2737        assert!(s.contains("\"partyMasking\":\"partial\""), "{s}");
2738        assert!(s.contains("\"showTranscript\":false"), "{s}");
2739        assert!(s.contains("\"showAudio\":true"), "{s}");
2740        assert!(s.contains("\"allowDownload\":true"), "{s}");
2741        // The owner muted their own side by default but left the other
2742        // party audible — both ride the wire as camelCase booleans.
2743        assert!(s.contains("\"defaultMuteLocal\":false"), "{s}");
2744        assert!(s.contains("\"defaultMuteRemote\":true"), "{s}");
2745    }
2746
2747    #[test]
2748    fn share_request_carries_invited_emails_for_restricted() {
2749        let req = ShareRecordingRequest {
2750            recording_source_id: "a".into(),
2751            visibility: ShareVisibility::Restricted,
2752            invited_emails: Some(vec!["alex@example.com".into()]),
2753            party_masking: None,
2754            show_transcript: None,
2755            show_audio: None,
2756            allow_download: None,
2757            default_mute_local: None,
2758            default_mute_remote: None,
2759            password: None,
2760            expires_at: None,
2761        };
2762        let s = serde_json::to_string(&req).unwrap();
2763        assert!(s.contains("\"visibility\":\"restricted\""), "{s}");
2764        assert!(
2765            s.contains("\"invitedEmails\":[\"alex@example.com\"]"),
2766            "{s}"
2767        );
2768    }
2769
2770    #[test]
2771    fn share_response_parses_platform_shape() {
2772        let raw = r#"{
2773            "visibility": "public",
2774            "token": "Zr7-x9F2k1QpLmN4sT8wYa",
2775            "shareUrl": "https://platform.wavekat.com/voice/s/Zr7-x9F2k1QpLmN4sT8wYa",
2776            "sharedAt": "2026-06-19T10:00:00.000Z"
2777        }"#;
2778        let parsed: ShareRecordingResponse = serde_json::from_str(raw).unwrap();
2779        assert_eq!(parsed.visibility, ShareVisibility::Public);
2780        assert_eq!(parsed.token, "Zr7-x9F2k1QpLmN4sT8wYa");
2781        assert!(parsed.share_url.ends_with(&parsed.token));
2782    }
2783
2784    #[test]
2785    fn share_state_parses_restricted_with_invited_emails() {
2786        // The GET read carries the audience back — this is the field the
2787        // POST reply omits and the desktop "who can open this" panel needs.
2788        let raw = r#"{
2789            "visibility": "restricted",
2790            "token": "Zr7-x9F2k1QpLmN4sT8wYa",
2791            "shareUrl": "https://platform.wavekat.com/voice/s/Zr7-x9F2k1QpLmN4sT8wYa",
2792            "sharedAt": "2026-06-19T10:00:00.000Z",
2793            "invitedEmails": ["bob@example.com", "carol@example.com"],
2794            "partyMasking": "full",
2795            "showTranscript": true,
2796            "showAudio": false,
2797            "allowDownload": false,
2798            "defaultMuteLocal": false,
2799            "defaultMuteRemote": true
2800        }"#;
2801        let parsed: ShareStateResponse = serde_json::from_str(raw).unwrap();
2802        assert_eq!(parsed.visibility, ShareVisibility::Restricted);
2803        assert_eq!(
2804            parsed.invited_emails.as_deref(),
2805            Some(
2806                [
2807                    "bob@example.com".to_string(),
2808                    "carol@example.com".to_string()
2809                ]
2810                .as_slice()
2811            )
2812        );
2813        // The visibility controls ride back on the live-share read.
2814        assert_eq!(parsed.party_masking, Some(PartyMasking::Full));
2815        assert_eq!(parsed.show_transcript, Some(true));
2816        assert_eq!(parsed.show_audio, Some(false));
2817        // Audio hidden here, so download comes back off (platform folds the two).
2818        assert_eq!(parsed.allow_download, Some(false));
2819        // Per-channel playback defaults ride back too.
2820        assert_eq!(parsed.default_mute_local, Some(false));
2821        assert_eq!(parsed.default_mute_remote, Some(true));
2822    }
2823
2824    #[test]
2825    fn share_state_parses_private_with_fields_absent() {
2826        // A never-shared (or revoked) recording reports private with no
2827        // token / url / emails — the optional fields stay None.
2828        let parsed: ShareStateResponse =
2829            serde_json::from_str(r#"{ "visibility": "private" }"#).unwrap();
2830        assert_eq!(parsed.visibility, ShareVisibility::Private);
2831        assert!(parsed.token.is_none());
2832        assert!(parsed.share_url.is_none());
2833        assert!(parsed.shared_at.is_none());
2834        assert!(parsed.invited_emails.is_none());
2835    }
2836
2837    #[test]
2838    fn share_request_rejects_empty_source_id_before_hitting_network() {
2839        // Guarded client-side so an empty id can't produce a path like
2840        // `/api/voice/recordings//share` that 404s confusingly.
2841        let req = ShareRecordingRequest {
2842            recording_source_id: String::new(),
2843            visibility: ShareVisibility::Private,
2844            invited_emails: None,
2845            party_masking: None,
2846            show_transcript: None,
2847            show_audio: None,
2848            allow_download: None,
2849            default_mute_local: None,
2850            default_mute_remote: None,
2851            password: None,
2852            expires_at: None,
2853        };
2854        // We can't call the async method without a runtime here, but the
2855        // guard mirrors `upload_recording_bytes` — assert the precondition
2856        // shape the method checks.
2857        assert!(req.recording_source_id.is_empty());
2858    }
2859
2860    // ---- VoiceAccounts ----
2861
2862    fn sample_account() -> VoiceAccountRecord {
2863        VoiceAccountRecord {
2864            source_id: "11111111-1111-4111-8111-111111111111".into(),
2865            enabled: true,
2866            display_name: "Work line".into(),
2867            username: "alice".into(),
2868            domain: "sip.example.com".into(),
2869            auth_username: Some("alice-auth".into()),
2870            server: Some("sip.example.com".into()),
2871            port: Some(5060),
2872            transport: VoiceTransport::Udp,
2873            register_expires: 60,
2874            keepalive_secs: Some(50),
2875            disclosure_enabled: true,
2876            updated_at: "2026-06-20T10:00:00Z".into(),
2877            deleted_at: None,
2878            envelope: SyncEnvelope::for_endpoint::<VoiceAccounts>(),
2879        }
2880    }
2881
2882    #[test]
2883    fn accounts_marker_resource_is_accounts() {
2884        // Path constant drives the URL in `Client::sync` / `Client::list`;
2885        // a rename here would silently 404 against the platform.
2886        assert_eq!(<VoiceAccounts as SyncEndpoint>::RESOURCE, "accounts");
2887    }
2888
2889    #[test]
2890    fn account_record_serializes_with_camel_case_and_envelope() {
2891        let s = serde_json::to_string(&sample_account()).unwrap();
2892        // Field-by-field wire contract — also what the platform's Zod
2893        // schema expects.
2894        assert!(s.contains("\"sourceId\":"), "{s}");
2895        assert!(s.contains("\"displayName\":\"Work line\""), "{s}");
2896        assert!(s.contains("\"authUsername\":\"alice-auth\""), "{s}");
2897        assert!(s.contains("\"registerExpires\":60"), "{s}");
2898        assert!(s.contains("\"keepaliveSecs\":50"), "{s}");
2899        assert!(s.contains("\"disclosureEnabled\":true"), "{s}");
2900        assert!(s.contains("\"transport\":\"udp\""), "{s}");
2901        assert!(s.contains("\"updatedAt\":\"2026-06-20T10:00:00Z\""), "{s}");
2902        // A live line carries no tombstone.
2903        assert!(!s.contains("deletedAt"), "deletedAt should be omitted: {s}");
2904        // The secret never crosses this wire, by construction.
2905        assert!(!s.contains("password"), "no password field: {s}");
2906        // Envelope flattens to the top, same as the other resources.
2907        assert!(s.contains("\"schemaVersion\":1"), "{s}");
2908    }
2909
2910    #[test]
2911    fn account_tombstone_serializes_deleted_at() {
2912        // A soft-delete rides as an upsert with deletedAt set — the
2913        // delete-propagation mechanism (doc 40).
2914        let mut r = sample_account();
2915        r.deleted_at = Some("2026-06-20T12:00:00Z".into());
2916        let s = serde_json::to_string(&r).unwrap();
2917        assert!(s.contains("\"deletedAt\":\"2026-06-20T12:00:00Z\""), "{s}");
2918    }
2919
2920    #[test]
2921    fn account_record_round_trips_optional_fields() {
2922        // A minimal line — no auth username, server, port, keepalive, or
2923        // tombstone — should parse with those all absent.
2924        let raw = r#"{
2925            "sourceId": "a",
2926            "enabled": false,
2927            "displayName": "Cheap trunk",
2928            "username": "u",
2929            "domain": "d",
2930            "transport": "tcp",
2931            "registerExpires": 120,
2932            "disclosureEnabled": false,
2933            "updatedAt": "2026-06-20T10:00:00Z"
2934        }"#;
2935        let parsed: VoiceAccountRecord = serde_json::from_str(raw).unwrap();
2936        assert!(!parsed.enabled);
2937        assert!(parsed.auth_username.is_none());
2938        assert!(parsed.server.is_none());
2939        assert!(parsed.port.is_none());
2940        assert!(parsed.keepalive_secs.is_none());
2941        assert!(parsed.deleted_at.is_none());
2942        assert_eq!(parsed.transport, VoiceTransport::Tcp);
2943        assert_eq!(parsed.register_expires, 120);
2944    }
2945
2946    #[test]
2947    fn voice_transport_round_trips_via_json() {
2948        for t in [VoiceTransport::Udp, VoiceTransport::Tcp] {
2949            let s = serde_json::to_string(&t).unwrap();
2950            let back: VoiceTransport = serde_json::from_str(&s).unwrap();
2951            assert_eq!(t, back);
2952        }
2953        // Pin the wire strings — the daemon's `TransportKind` and the
2954        // platform's Zod enum both depend on these exact tokens.
2955        assert_eq!(
2956            serde_json::to_string(&VoiceTransport::Udp).unwrap(),
2957            "\"udp\""
2958        );
2959        assert_eq!(
2960            serde_json::to_string(&VoiceTransport::Tcp).unwrap(),
2961            "\"tcp\""
2962        );
2963    }
2964
2965    #[test]
2966    fn accounts_query_omits_unset_and_serializes_include_deleted() {
2967        let empty = serde_json::to_string(&VoiceAccountsQuery::default()).unwrap();
2968        assert_eq!(empty, "{}", "default query should be empty: {empty}");
2969        let with_deleted = serde_json::to_string(&VoiceAccountsQuery {
2970            include_deleted: Some(true),
2971        })
2972        .unwrap();
2973        assert!(
2974            with_deleted.contains("\"includeDeleted\":true"),
2975            "{with_deleted}"
2976        );
2977    }
2978
2979    // ---- VoiceFlows ----
2980
2981    #[test]
2982    fn flows_query_serializes_cursor_and_omits_absent_fields() {
2983        let empty = serde_json::to_string(&VoiceFlowsQuery::default()).unwrap();
2984        assert_eq!(empty, "{}");
2985        let cursored = serde_json::to_string(&VoiceFlowsQuery {
2986            after: Some("flow_abc".into()),
2987            limit: Some(100),
2988            schema_versions: None,
2989        })
2990        .unwrap();
2991        assert!(cursored.contains("\"after\":\"flow_abc\""), "{cursored}");
2992        assert!(cursored.contains("\"limit\":100"), "{cursored}");
2993    }
2994
2995    #[test]
2996    fn flows_query_sends_schema_versions_under_the_servers_name() {
2997        // The struct is camelCase; this parameter is not. A silently
2998        // camelCased key is ignored by the server, which reads exactly
2999        // like an account with no flows in that version — so pin it.
3000        let query = serde_json::to_string(&VoiceFlowsQuery {
3001            schema_versions: Some("1,2".into()),
3002            ..Default::default()
3003        })
3004        .unwrap();
3005        assert_eq!(query, r#"{"schema_versions":"1,2"}"#);
3006    }
3007
3008    // ---- Booking ----
3009
3010    #[test]
3011    fn booking_slots_request_uses_the_routes_snake_case_wire() {
3012        // Unlike the sync resources above, these routes speak snake_case.
3013        // A camelCased body is rejected as a validation error mid-call,
3014        // which the flow can only render as "unavailable".
3015        let body = serde_json::to_string(&BookingSlotsRequest {
3016            source_id: "call_1".into(),
3017            duration_mins: 30,
3018            buffer_mins: 10,
3019            lead_mins: 120,
3020            horizon_days: 14,
3021            schedule: BookingSchedule {
3022                tue: vec![BookingTimeRange {
3023                    open: "09:00".into(),
3024                    close: "17:00".into(),
3025                }],
3026                ..Default::default()
3027            },
3028            timezone: "Pacific/Auckland".into(),
3029            exceptions: Vec::new(),
3030            limit: 3,
3031        })
3032        .unwrap();
3033        assert!(body.contains(r#""source_id":"call_1""#), "{body}");
3034        assert!(body.contains(r#""duration_mins":30"#), "{body}");
3035        assert!(body.contains(r#""timezone":"Pacific/Auckland""#), "{body}");
3036        // Days with no hours, and an empty exception list, stay off the
3037        // wire entirely rather than shipping empty arrays.
3038        assert!(!body.contains("\"mon\""), "{body}");
3039        assert!(!body.contains("exceptions"), "{body}");
3040    }
3041
3042    #[test]
3043    fn booking_slots_response_parses_both_answers() {
3044        let offered: BookingSlotsResponse = serde_json::from_str(
3045            r#"{"slots":[{"start":"2026-08-11T21:00:00Z","end":"2026-08-11T21:30:00Z"}],"timezone":"Pacific/Auckland"}"#,
3046        )
3047        .unwrap();
3048        assert_eq!(offered.slots.len(), 1);
3049        assert_eq!(offered.timezone, "Pacific/Auckland");
3050        assert!(offered.status.is_none());
3051
3052        // The calendar could not be read. Not an error to the caller of
3053        // this crate — the flow has an exit for it.
3054        let down: BookingSlotsResponse =
3055            serde_json::from_str(r#"{"status":"unavailable","reason":"not_connected"}"#).unwrap();
3056        assert!(down.slots.is_empty());
3057        assert_eq!(down.status.as_deref(), Some("unavailable"));
3058        assert_eq!(down.reason.as_deref(), Some("not_connected"));
3059    }
3060
3061    #[test]
3062    fn booking_book_response_parses_every_outcome() {
3063        let booked: BookingBookResponse =
3064            serde_json::from_str(r#"{"status":"booked","start":"2026-08-11T21:00:00Z"}"#).unwrap();
3065        assert_eq!(booked.status, "booked");
3066        assert_eq!(booked.start.as_deref(), Some("2026-08-11T21:00:00Z"));
3067
3068        let taken: BookingBookResponse =
3069            serde_json::from_str(r#"{"status":"slot_taken"}"#).unwrap();
3070        assert_eq!(taken.status, "slot_taken");
3071        assert!(taken.start.is_none());
3072
3073        // A status this build has never heard of still parses: failing
3074        // here would drop a live call over an unknown string.
3075        let future: BookingBookResponse =
3076            serde_json::from_str(r#"{"status":"needs_deposit"}"#).unwrap();
3077        assert_eq!(future.status, "needs_deposit");
3078    }
3079
3080    #[test]
3081    fn flows_page_parses_platform_shape() {
3082        let raw = r#"{
3083            "items": [{
3084                "id": "flow_1",
3085                "name": "Luigi's — after hours",
3086                "version": 3,
3087                "yaml": "schema_version: 1\n",
3088                "publishedAt": "2026-07-13T10:00:00Z"
3089            }],
3090            "nextAfter": null
3091        }"#;
3092        let page: VoiceFlowsPage = serde_json::from_str(raw).unwrap();
3093        assert_eq!(page.items.len(), 1);
3094        let rec = &page.items[0];
3095        assert_eq!(rec.id, "flow_1");
3096        assert_eq!(rec.version, 3);
3097        assert_eq!(rec.published_at, "2026-07-13T10:00:00Z");
3098        assert!(page.next_after.is_none());
3099
3100        // A mid-walk page carries the cursor.
3101        let more: VoiceFlowsPage =
3102            serde_json::from_str(r#"{ "items": [], "nextAfter": "flow_1" }"#).unwrap();
3103        assert_eq!(more.next_after.as_deref(), Some("flow_1"));
3104    }
3105
3106    #[test]
3107    fn flow_assets_manifest_parses_platform_shape() {
3108        // `ref` (a reserved word) maps to `asset_ref`; a null duration is
3109        // accepted (the platform doesn't always know it).
3110        let raw = r#"{
3111            "assets": [{
3112                "ref": "vprompt_ab12cd34",
3113                "format": "ulaw_8000",
3114                "byteSize": 48044,
3115                "durationMs": null,
3116                "contentHash": "9f2c00aa"
3117            }]
3118        }"#;
3119        let page: VoiceFlowAssetsPage = serde_json::from_str(raw).unwrap();
3120        assert_eq!(page.assets.len(), 1);
3121        let asset = &page.assets[0];
3122        assert_eq!(asset.asset_ref, "vprompt_ab12cd34");
3123        assert_eq!(asset.format, "ulaw_8000");
3124        assert_eq!(asset.byte_size, 48044);
3125        assert!(asset.duration_ms.is_none());
3126        assert_eq!(asset.content_hash, "9f2c00aa");
3127
3128        // A text-only version legitimately has no frozen audio.
3129        let empty: VoiceFlowAssetsPage = serde_json::from_str(r#"{ "assets": [] }"#).unwrap();
3130        assert!(empty.assets.is_empty());
3131    }
3132
3133    #[test]
3134    fn account_record_accepts_unknown_extras_for_forward_compat() {
3135        // A newer client shipping a field this platform version lacks a
3136        // column for round-trips via the `extras` envelope.
3137        let raw = r#"{
3138            "sourceId": "a",
3139            "enabled": true,
3140            "displayName": "x",
3141            "username": "u",
3142            "domain": "d",
3143            "transport": "udp",
3144            "registerExpires": 60,
3145            "disclosureEnabled": true,
3146            "updatedAt": "2026-06-20T10:00:00Z",
3147            "schemaVersion": 2,
3148            "extras": { "ringtone": "classic" }
3149        }"#;
3150        let parsed: VoiceAccountRecord = serde_json::from_str(raw).unwrap();
3151        assert_eq!(parsed.envelope.schema_version, Some(2));
3152        let extras = parsed.envelope.extras.as_ref().expect("extras present");
3153        assert_eq!(extras["ringtone"], "classic");
3154    }
3155
3156    #[test]
3157    fn system_flow_record_parses_the_platform_shape() {
3158        // The full wire shape as served by the platform's system flow
3159        // endpoint: all fields present including optionals.
3160        let json = r#"{
3161            "id": "flow_voicemail",
3162            "name": "Voicemail",
3163            "description": "A short greeting.",
3164            "language": "en",
3165            "version": 2,
3166            "yaml": "schema_version: 1\n",
3167            "publishedAt": "2026-08-27 01:02:03",
3168            "access": "open",
3169            "systemTags": ["system", "access:open"]
3170        }"#;
3171        let rec: VoiceSystemFlowRecord = serde_json::from_str(json).unwrap();
3172        assert_eq!(rec.id, "flow_voicemail");
3173        assert_eq!(rec.name, "Voicemail");
3174        assert_eq!(rec.description, "A short greeting.");
3175        assert_eq!(rec.language, "en");
3176        assert_eq!(rec.version, 2);
3177        assert_eq!(rec.yaml, "schema_version: 1\n");
3178        assert_eq!(rec.published_at, Some("2026-08-27 01:02:03".into()));
3179        assert_eq!(rec.access, "open");
3180        assert_eq!(rec.system_tags, vec!["system", "access:open"]);
3181    }
3182
3183    #[test]
3184    fn system_flow_record_tolerates_missing_optionals_and_unknown_fields() {
3185        // Older rows or newer platforms: description, publishedAt,
3186        // systemTags may be absent; unknown fields must be ignored
3187        // (forward compat).
3188        let json = r#"{"id":"f","name":"n","language":"en","version":1,"yaml":"y","access":"account","someFutureField":1}"#;
3189        let rec: VoiceSystemFlowRecord = serde_json::from_str(json).unwrap();
3190        assert_eq!(rec.id, "f");
3191        assert_eq!(rec.name, "n");
3192        assert_eq!(rec.description, "");
3193        assert_eq!(rec.language, "en");
3194        assert_eq!(rec.version, 1);
3195        assert_eq!(rec.yaml, "y");
3196        assert!(rec.published_at.is_none());
3197        assert_eq!(rec.access, "account");
3198        assert!(rec.system_tags.is_empty());
3199    }
3200}