Fathom TypeScript SDK

Common errors

• TypeError: fathom.listMeetings is not a function

  cause The `Fathom` client instance was not correctly initialized or the import path for the SDK is wrong, leading to an undefined or incorrect object.
  fix Ensure `import { Fathom } from "fathom-typescript";` is present and the `fathom` object is correctly instantiated with `const fathom = new Fathom({...});`.

• Error: Missing required authentication scheme `apiKeyAuth` or `bearerAuth` for security.

  cause The `security` object was not provided or was incomplete during the `Fathom` client initialization, preventing proper API authentication.
  fix Pass a valid `security` object with either `apiKeyAuth` or `bearerAuth` when creating the `Fathom` instance: `new Fathom({ security: { apiKeyAuth: process.env.FATHOM_API_KEY ?? '' } })`.

• Property 'someInvalidProperty' does not exist on type 'ListMeetingsRequest'.

  cause Attempting to pass an unknown or mistyped property to an API request object, indicating a mismatch with the SDK's type definitions.
  fix Consult the SDK's type definitions or the Fathom API documentation to ensure all request parameters are correctly named and typed according to the API specification for the specific operation.

Warnings

• breaking As a pre-1.0 release, minor versions (`0.x.0` to `0.y.0`) and even patch versions (`0.0.x` to `0.0.y`) of `fathom-typescript` may introduce breaking API changes without strictly adhering to semantic versioning.
  Fix: Always consult the changelog for each update. Consider pinning exact versions in `package.json` (e.g., `"fathom-typescript": "~0.0.37"` instead of `"^0.0.37"`) and manually review before upgrading to avoid unexpected behavior.
• gotcha Hardcoding API keys directly in source code or committing them to version control (like in the quickstart example) is a significant security risk.
  Fix: Always use environment variables (e.g., `process.env.FATHOM_API_KEY`), a secure configuration management system, or a secret manager to handle sensitive credentials. Replace `<YOUR_API_KEY_HERE>` with a dynamically loaded secret.
• gotcha API operations that return multiple results (e.g., `listMeetings`) often implement pagination. Incorrectly handling pagination (e.g., forgetting to iterate or access subsequent pages) can lead to incomplete data retrieval.
  Fix: Utilize the provided asynchronous iterator pattern (e.g., `for await (const page of result)`) to ensure all available pages of data are fetched correctly for paginated responses.

Install

• npm install fathom-typescript npm
• yarn add fathom-typescript yarn
• pnpm add fathom-typescript pnpm

Imports

• Fathom
  wrong:

  const Fathom = require('fathom-typescript');

  correct:

  import { Fathom } from 'fathom-typescript';

  The primary SDK client class. Supports both CommonJS and ES Modules environments.
• ListMeetingsResponse

  import type { ListMeetingsResponse } from 'fathom-typescript/dist/sdk/models/operations';

  Example of importing a specific type for an API operation's response for enhanced type safety. The exact path to specific types might vary based on SDK structure.
• MeetingType

  import type { MeetingType } from 'fathom-typescript/dist/sdk/models/shared';

  Example of importing an enum type used for request parameters, ensuring type-safe API calls. The exact path to shared types might vary.

Quickstart

Initializes the Fathom SDK client with an API key and demonstrates how to list meetings, iterating through potentially paginated results securely.

import { Fathom } from "fathom-typescript";

const fathom = new Fathom({
  security: {
    apiKeyAuth: process.env.FATHOM_API_KEY ?? 'YOUR_API_KEY_HERE',
  },
});

async function run() {
  try {
    const result = await fathom.listMeetings({
      calendarInviteesDomains: [
        "acme.com",
        "client.com"
      ],
      meetingType: "all",
      recordedBy: [
        "ceo@acme.com",
        "pm@acme.com"
      ],
      teams: [
        "Sales",
        "Engineering"
      ]
    });

    if (result) {
      for await (const page of result) {
        console.log("Retrieved meetings for page:", page);
      }
    } else {
      console.log("No meetings found or an empty result was returned.");
    }
  } catch (error) {
    console.error("Error listing meetings:", error);
  }
}

run();