types.ts

packages/fathom-client/src/types.ts

1. /**
2. * Fathom shapes, projected from the OpenAPI spec and corrected against live
3. * responses.
4. *
5. * Strict about the fields decisions are made from, permissive about the rest
6. * (rule 4). Everything here that we do not act on is optional,
7. * and unknown keys are simply ignored rather than rejected.
8. */
10. /**
11. * A person as Fathom sends one. Both fields are nullable and that is not
12. * theoretical: live assignees arrive with `email: null`, and occasionally with
13. * both null. Attribution lives in
14. * config/fathom-people.ts, not here; a client package has no roster.
15. */
16. export interface FathomPerson {
17. name: string | null
18. email: string | null
19. /** Fathom's own team label. Null on most records; we do not read it. */
20. team?: string | null
21. }
23. /** An invitee, which is a person plus Fathom's own verdict on whether they are external. */
24. export interface FathomInvitee extends FathomPerson {
25. email_domain?: string | null
26. /**
27. * Trusted over any domain list. Northgate alone arrives under two domains,
28. * northgate.example and northgate-studio.example, so a hand-kept table would
29. * silently treat half their staff as internal.
30. */
31. is_external: boolean
32. }
34. export interface FathomActionItem {
35. description: string
36. /** True when a human typed it rather than the model extracting it. */
37. user_generated?: boolean
38. completed?: boolean
39. /** HH:MM:SS from the start of the recording. */
40. recording_timestamp?: string | null
41. /** Deep link straight to the moment it was said. The reason this beats a bare list. */
42. recording_playback_url?: string | null
43. /** Null, or `{name: null, email: null}`, both mean nobody was named. */
44. assignee: FathomPerson | null
45. }
47. export interface FathomMeeting {
48. title: string
49. meeting_title?: string | null
50. meeting_type?: string | null
51. recording_id: number
52. url: string
53. share_url?: string | null
54. created_at: string
55. recording_start_time?: string | null
56. recording_end_time?: string | null
57. /**
58. * Who inside the org may see this, in Fathom's own words: `no_teams` means
59. * private to the recorder. Every meeting on this account reads `no_teams`,
60. * which is why the board cannot rely on Fathom's permissions and gates by
61. * participant itself. Why it reads that way is not established (rule 1).
62. *
63. * This field does not describe who can see a meeting either: keys return
64. * `no_teams` meetings recorded by someone other than the key's owner. Read it
65. * as a team-sharing flag and nothing more.
66. */
67. shared_with?: 'no_teams' | 'single_team' | 'multiple_teams' | 'all_teams' | string
68. calendar_invitees_domains_type?: string | null
69. calendar_invitees: FathomInvitee[]
70. recorded_by: FathomPerson
71. /** Present only when include_action_items was set. Null otherwise, not []. */
72. action_items?: FathomActionItem[] | null
73. /** Never requested by this client. See constants.ts on the heavy bucket. */
74. transcript?: null
75. default_summary?: null
76. }
78. /**
79. * A window of meetings, plus whether it is the whole window.
80. *
81. * `truncated` is not cosmetic, same contract as OrderWindow and LeadWindow: a
82. * caller cannot tell a complete sweep from a capped one by looking at the rows,
83. * and a floor presented as a total misstates the window (rule 5).
84. */
85. export interface MeetingWindow {
86. meetings: FathomMeeting[]
87. truncated: boolean
88. pages: number
89. }