@interfere/attio

An unofficial developer-friendly & type-safe Typescript SDK specifically catered to leverage the Attio REST API.

Summary

Table of Contents

• @interfere/attio
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

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

NPM

npm add @interfere/attio

PNPM

pnpm add @interfere/attio

Bun

bun add @interfere/attio

Yarn

yarn add @interfere/attio

[!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 { Attio } from "@interfere/attio";

const attio = new Attio({
  oauth2: process.env["ATTIO_OAUTH2"] ?? "",
});

async function run() {
  const result = await attio.objects.list();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ------ | ------------ | -------------------- | | oauth2 | oauth2 | OAuth2 token | ATTIO_OAUTH2 |

To authenticate with the API the oauth2 parameter must be set when initializing the SDK client instance. For example:

import { Attio } from "@interfere/attio";

const attio = new Attio({
  oauth2: process.env["ATTIO_OAUTH2"] ?? "",
});

async function run() {
  const result = await attio.objects.list();

  console.log(result);
}

run();

Available Resources and Operations

Attributes

• list - List attributes
• create - Create an attribute
• get - Get an attribute
• update - Update an attribute
• listOptions - List select options
• createOption - Create a select option
• updateOption - Update a select option
• listStatuses - List statuses
• createStatus - Create a status
• updateStatus - Update a status

CallRecordings

• listByMeeting - List call recordings
• create - Create call recording
• get - Get call recording
• delete - Delete call recording

Comments

• create - Create a comment
• get - Get a comment
• delete - Delete a comment

Entries

• query - List entries
• create - Create an entry (add record to list)
• upsertByParent - Assert a list entry by parent
• get - Get a list entry
• appendUpdate - Update a list entry (append multiselect values)
• update - Update a list entry (overwrite multiselect values)
• delete - Delete a list entry
• listAttributeValues - List attribute values for a list entry

Lists

• list - List all lists
• create - Create a list
• get - Get a list
• update - Update a list

Meetings

• list - List meetings
• createOrFind - Find or create a meeting
• get - Get a meeting

Meta

• identify - Identify

Notes

• list - List notes
• create - Create a note
• get - Get a note
• delete - Delete a note

Objects

• list - List objects
• create - Create an object
• get - Get an object
• update - Update an object

Records

• query - List records
• create - Create a record
• assert - Assert a record
• get - Get a record
• update - Update a record (append multiselect values)
• overwriteUpdate - Update a record (overwrite multiselect values)
• delete - Delete a record
• getAttributeValues - List record attribute values
• listEntries - List record entries
• search - Search records

ScimSchemas

• list - List SCIM schemas

Tasks

• list - List tasks
• create - Create a task
• get - Get a task
• update - Update a task
• delete - Delete a task

Threads

• list - List threads
• get - Get a thread

Transcripts

• get - Get call transcript

Webhooks

• list - List webhooks
• create - Create a webhook
• get - Get a webhook
• update - Update a webhook
• delete - Delete a webhook

WorkspaceMembers

• list - List workspace members
• get - Get a workspace member

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.

• attributesCreate - Create an attribute
• attributesCreateOption - Create a select option
• attributesCreateStatus - Create a status
• attributesGet - Get an attribute
• attributesList - List attributes
• attributesListOptions - List select options
• attributesListStatuses - List statuses
• attributesUpdate - Update an attribute
• attributesUpdateOption - Update a select option
• attributesUpdateStatus - Update a status
• callRecordingsCreate - Create call recording
• callRecordingsDelete - Delete call recording
• callRecordingsGet - Get call recording
• callRecordingsListByMeeting - List call recordings
• commentsCreate - Create a comment
• commentsDelete - Delete a comment
• commentsGet - Get a comment
• entriesAppendUpdate - Update a list entry (append multiselect values)
• entriesCreate - Create an entry (add record to list)
• entriesDelete - Delete a list entry
• entriesGet - Get a list entry
• entriesListAttributeValues - List attribute values for a list entry
• entriesQuery - List entries
• entriesUpdate - Update a list entry (overwrite multiselect values)
• entriesUpsertByParent - Assert a list entry by parent
• listsCreate - Create a list
• listsGet - Get a list
• listsList - List all lists
• listsUpdate - Update a list
• meetingsCreateOrFind - Find or create a meeting
• meetingsGet - Get a meeting
• meetingsList - List meetings
• metaIdentify - Identify
• notesCreate - Create a note
• notesDelete - Delete a note
• notesGet - Get a note
• notesList - List notes
• objectsCreate - Create an object
• objectsGet - Get an object
• objectsList - List objects
• objectsUpdate - Update an object
• recordsAssert - Assert a record
• recordsCreate - Create a record
• recordsDelete - Delete a record
• recordsGet - Get a record
• recordsGetAttributeValues - List record attribute values
• recordsListEntries - List record entries
• recordsOverwriteUpdate - Update a record (overwrite multiselect values)
• recordsQuery - List records
• recordsSearch - Search records
• recordsUpdate - Update a record (append multiselect values)
• scimSchemasList - List SCIM schemas
• tasksCreate - Create a task
• tasksDelete - Delete a task
• tasksGet - Get a task
• tasksList - List tasks
• tasksUpdate - Update a task
• threadsGet - Get a thread
• threadsList - List threads
• transcriptsGet - Get call transcript
• webhooksCreate - Create a webhook
• webhooksDelete - Delete a webhook
• webhooksGet - Get a webhook
• webhooksList - List webhooks
• webhooksUpdate - Update a webhook
• workspaceMembersGet - Get a workspace member
• workspaceMembersList - List workspace members

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 { Attio } from "@interfere/attio";

const attio = new Attio({
  oauth2: process.env["ATTIO_OAUTH2"] ?? "",
});

async function run() {
  const result = await attio.objects.list({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

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 { Attio } from "@interfere/attio";

const attio = new Attio({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  oauth2: process.env["ATTIO_OAUTH2"] ?? "",
});

async function run() {
  const result = await attio.objects.list();

  console.log(result);
}

run();

Error Handling

AttioBaseError 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 | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Attio } from "@interfere/attio";
import * as errors from "@interfere/attio/models/errors";

const attio = new Attio({
  oauth2: process.env["ATTIO_OAUTH2"] ?? "",
});

async function run() {
  try {
    const result = await attio.objects.create({
      data: {
        apiSlug: "people",
        singularNoun: "Person",
        pluralNoun: "People",
      },
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AttioBaseError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.PostV2ObjectsSlugConflictError) {
        console.log(error.data$.statusCode); // number
        console.log(error.data$.type); // operations.PostV2ObjectsType
        console.log(error.data$.code); // operations.PostV2ObjectsCode
        console.log(error.data$.message); // string
      }
    }
  }
}

run();

Error Classes

Primary error:

• AttioBaseError: 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 AttioBaseError:

• GetV2ObjectsObjectNotFoundError: Not Found. Status code 404. Applicable to 9 of 67 methods.*
• GetV2TargetIdentifierAttributesAttributeNotFoundError: Not Found. Status code 404. Applicable to 9 of 67 methods.*
• GetV2ListsListNotFoundError: Not Found. Status code 404. Applicable to 8 of 67 methods.*
• MissingValueError: Bad Request. Status code 400. Applicable to 2 of 67 methods.*
• PostV2ListsValueNotFoundError: Bad Request. Status code 400. Applicable to 2 of 67 methods.*
• ImmutableValueError: Bad Request. Status code 400. Applicable to 2 of 67 methods.*
• PostV2TasksValidationTypeError: Bad Request. Status code 400. Applicable to 2 of 67 methods.*
• GetV2ObjectsObjectRecordsRecordIdNotFoundError: Not Found. Status code 404. Applicable to 2 of 67 methods.*
• GetV2NotesNoteIdNotFoundError: Not Found. Status code 404. Applicable to 2 of 67 methods.*
• GetV2TasksTaskIdNotFoundError: Not Found. Status code 404. Applicable to 2 of 67 methods.*
• GetV2WebhooksWebhookIdNotFoundError: Not Found. Status code 404. Applicable to 2 of 67 methods.*
• PostV2TargetIdentifierAttributesAttributeOptionsSlugConflictError: Conflict. Status code 409. Applicable to 2 of 67 methods.*
• PostV2TargetIdentifierAttributesAttributeStatusesSlugConflictError: Conflict. Status code 409. Applicable to 2 of 67 methods.*
• PatchV2ObjectsObjectValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2TargetIdentifierAttributesValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• SystemEditUnauthorizedError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2TargetIdentifierAttributesAttributeOptionsValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PatchV2TargetIdentifierAttributesAttributeOptionsOptionValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2TargetIdentifierAttributesAttributeStatusesValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PatchV2TargetIdentifierAttributesAttributeStatusesStatusValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• FilterError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2ObjectsObjectRecordsValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PutV2ObjectsObjectRecordsValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2ObjectsRecordsSearchValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2ListsListEntriesValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• MultipleMatchResultsError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2CommentsValueNotFoundError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2MeetingsValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2MeetingsMeetingIdCallRecordingsValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• PostV2WebhooksValidationTypeError: Bad Request. Status code 400. Applicable to 1 of 67 methods.*
• BillingError: Forbidden. Status code 403. Applicable to 1 of 67 methods.*
• AuthError: Forbidden. Status code 403. Applicable to 1 of 67 methods.*
• PostV2TargetIdentifierAttributesNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• PostV2ObjectsObjectRecordsQueryNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• PostV2ListsNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• PostV2ListsListEntriesNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• PutV2ListsListEntriesNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• GetV2WorkspaceMembersWorkspaceMemberIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• PatchV2TasksTaskIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• GetV2ThreadsThreadIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• GetV2CommentsCommentIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• DeleteV2CommentsCommentIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• GetV2MeetingsMeetingIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• PostV2MeetingsMeetingIdCallRecordingsNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• GetV2MeetingsMeetingIdCallRecordingsCallRecordingIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• DeleteV2MeetingsMeetingIdCallRecordingsCallRecordingIdNotFoundError: Call recording not found. Status code 404. Applicable to 1 of 67 methods.*
• DeleteV2WebhooksWebhookIdNotFoundError: Not Found. Status code 404. Applicable to 1 of 67 methods.*
• PostV2ObjectsSlugConflictError: Conflict. Status code 409. Applicable to 1 of 67 methods.*
• PatchV2ObjectsObjectSlugConflictError: Conflict. Status code 409. Applicable to 1 of 67 methods.*
• PostV2TargetIdentifierAttributesSlugConflictError: Conflict. Status code 409. Applicable to 1 of 67 methods.*
• PostV2ListsSlugConflictError: Conflict. Status code 409. Applicable to 1 of 67 methods.*
• 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.

* Check the method documentation to see if the error is applicable.

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 { Attio } from "@interfere/attio";

const attio = new Attio({
  serverURL: "https://api.attio.com",
  oauth2: process.env["ATTIO_OAUTH2"] ?? "",
});

async function run() {
  const result = await attio.objects.list();

  console.log(result);
}

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:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { Attio } from "@interfere/attio";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@interfere/attio/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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 Attio({ 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 { Attio } from "@interfere/attio";

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

You can also enable a default debug logger by setting an environment variable ATTIO_DEBUG to true.

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.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy