fathom-typescript

Fathom's official TypeScript SDK.

Summary

Fathom External API: The Fathom External API lets you poll meetings, teams, and team members, and optionally receive webhooks when content from a new meeting is ready.

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add fathom-typescript

PNPM

pnpm add fathom-typescript

Bun

bun add fathom-typescript

Yarn

yarn add fathom-typescript

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Fathom } from "fathom-typescript";

const fathom = new Fathom({
  security: {
    apiKeyAuth: "<YOUR_API_KEY_HERE>",
  },
});

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

  for await (const page of result) {
    console.log(page);
  }
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | | ------------ | ------ | ----------- | | apiKeyAuth | apiKey | API key | | bearerAuth | http | HTTP Bearer |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Fathom } from "fathom-typescript";

const fathom = new Fathom({
  security: {
    apiKeyAuth: "<YOUR_API_KEY_HERE>",
  },
});

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

  for await (const page of result) {
    console.log(page);
  }
}

run();

Available Resources and Operations

Fathom SDK

• listMeetings - List meetings
• getRecordingSummary - Get summary
• getRecordingTranscript - Get transcript
• listTeams - List teams
• listTeamMembers - List team members
• createWebhook - Create a webhook
• deleteWebhook - Delete a webhook

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• createWebhook - Create a webhook
• deleteWebhook - Delete a webhook
• getRecordingSummary - Get summary
• getRecordingTranscript - Get transcript
• listMeetings - List meetings
• listTeamMembers - List team members
• listTeams - List teams

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Fathom } from "fathom-typescript";

const fathom = new Fathom({
  security: {
    apiKeyAuth: "<YOUR_API_KEY_HERE>",
  },
});

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

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Fathom } from "fathom-typescript";

const fathom = new Fathom({
  security: {
    apiKeyAuth: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await fathom.listMeetings({
    calendarInviteesDomains: [
      "acme.com",
      "client.com",
    ],
    meetingType: "all",
    recordedBy: [
      "[email protected]",
      "[email protected]",
    ],
    teams: [
      "Sales",
      "Engineering",
    ],
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Fathom } from "fathom-typescript";

const fathom = new Fathom({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    apiKeyAuth: "<YOUR_API_KEY_HERE>",
  },
});

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

  for await (const page of result) {
    console.log(page);
  }
}

run();

Error Handling

FathomError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { Fathom } from "fathom-typescript";
import * as errors from "fathom-typescript/sdk/models/errors";

const fathom = new Fathom({
  security: {
    apiKeyAuth: "<YOUR_API_KEY_HERE>",
  },
});

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

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    if (error instanceof errors.FathomError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• FathomError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from FathomError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Fathom } from "fathom-typescript";

const fathom = new Fathom({
  serverURL: "https://api.fathom.ai/external/v1",
  security: {
    apiKeyAuth: "<YOUR_API_KEY_HERE>",
  },
});

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

  for await (const page of result) {
    console.log(page);
  }
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Fathom } from "fathom-typescript";
import { HTTPClient } from "fathom-typescript/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Fathom({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Fathom } from "fathom-typescript";

const sdk = new Fathom({ debugLogger: console });