npm package: @interfere/attio
Description: An unofficial developer-friendly & type-safe Typescript SDK specifically catered to leverage the *Attio REST API*.
Author: Interfere, Inc.
Latest version: 0.2.9

# @interfere/attio

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

[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=@interfere/attio&utm_campaign=typescript)
[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)

<!-- Start Summary [summary] -->
## Summary


<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [@interfere/attio](#interfereattio)
  * [SDK Installation](#sdk-installation)
  * [Requirements](#requirements)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Standalone functions](#standalone-functions)
  * [File uploads](#file-uploads)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Debugging](#debugging)
* [Development](#development)
  * [Maturity](#maturity)
  * [Contributions](#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.

### NPM

```bash
npm add @interfere/attio
```

### PNPM

```bash
pnpm add @interfere/attio
```

### Bun

```bash
bun add @interfere/attio
```

### Yarn

```bash
yarn add @interfere/attio
```

> [!NOTE]
> This package is published with CommonJS and ES Modules (ESM) support.
<!-- End SDK Installation [installation] -->

<!-- Start Requirements [requirements] -->
## Requirements

For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
<!-- End Requirements [requirements] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```typescript
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();

```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## 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:
```typescript
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();

```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [Attributes](docs/sdks/attributes/README.md)

* [listAll](docs/sdks/attributes/README.md#listall) - List attributes
* [createNew](docs/sdks/attributes/README.md#createnew) - Create an attribute
* [get](docs/sdks/attributes/README.md#get) - Get an attribute
* [update](docs/sdks/attributes/README.md#update) - Update an attribute
* [updateSelectOption](docs/sdks/attributes/README.md#updateselectoption) - Update a select option
* [listStatuses](docs/sdks/attributes/README.md#liststatuses) - List statuses
* [createStatus](docs/sdks/attributes/README.md#createstatus) - Create a status
* [updateStatus](docs/sdks/attributes/README.md#updatestatus) - Update a status

### [Attributes.Options](docs/sdks/options/README.md)

* [list](docs/sdks/options/README.md#list) - List select options
* [create](docs/sdks/options/README.md#create) - Create a select option

### [CallRecordings](docs/sdks/callrecordings/README.md)

* [list](docs/sdks/callrecordings/README.md#list) - List call recordings
* [create](docs/sdks/callrecordings/README.md#create) - Create call recording
* [get](docs/sdks/callrecordings/README.md#get) - Get call recording
* [delete](docs/sdks/callrecordings/README.md#delete) - Delete call recording

### [Comments](docs/sdks/comments/README.md)

* [create](docs/sdks/comments/README.md#create) - Create a comment
* [get](docs/sdks/comments/README.md#get) - Get a comment
* [delete](docs/sdks/comments/README.md#delete) - Delete a comment

### [Entries](docs/sdks/entries/README.md)

* [query](docs/sdks/entries/README.md#query) - List entries
* [create](docs/sdks/entries/README.md#create) - Create an entry (add record to list)
* [assert](docs/sdks/entries/README.md#assert) - Assert a list entry by parent
* [get](docs/sdks/entries/README.md#get) - Get a list entry
* [updateAppending](docs/sdks/entries/README.md#updateappending) - Update a list entry (append multiselect values)
* [update](docs/sdks/entries/README.md#update) - Update a list entry (overwrite multiselect values)
* [delete](docs/sdks/entries/README.md#delete) - Delete a list entry
* [listAttributeValues](docs/sdks/entries/README.md#listattributevalues) - List attribute values for a list entry

### [Files](docs/sdks/files/README.md)

* [list](docs/sdks/files/README.md#list) - List files
* [create](docs/sdks/files/README.md#create) - Create a folder
* [upload](docs/sdks/files/README.md#upload) - Upload a file
* [get](docs/sdks/files/README.md#get) - Get a file
* [delete](docs/sdks/files/README.md#delete) - Delete a file
* [download](docs/sdks/files/README.md#download) - Download a file

### [Lists](docs/sdks/lists/README.md)

* [list](docs/sdks/lists/README.md#list) - List all lists
* [create](docs/sdks/lists/README.md#create) - Create a list
* [get](docs/sdks/lists/README.md#get) - Get a list
* [update](docs/sdks/lists/README.md#update) - Update a list
* [getViews](docs/sdks/lists/README.md#getviews) - List views for list

### [Meetings](docs/sdks/meetings/README.md)

* [list](docs/sdks/meetings/README.md#list) - List meetings
* [findOrCreate](docs/sdks/meetings/README.md#findorcreate) - Find or create a meeting
* [get](docs/sdks/meetings/README.md#get) - Get a meeting

### [Meta](docs/sdks/meta/README.md)

* [identify](docs/sdks/meta/README.md#identify) - Identify

### [Notes](docs/sdks/notes/README.md)

* [list](docs/sdks/notes/README.md#list) - List notes
* [create](docs/sdks/notes/README.md#create) - Create a note
* [get](docs/sdks/notes/README.md#get) - Get a note
* [delete](docs/sdks/notes/README.md#delete) - Delete a note

### [Objects](docs/sdks/objects/README.md)

* [list](docs/sdks/objects/README.md#list) - List objects
* [create](docs/sdks/objects/README.md#create) - Create an object
* [get](docs/sdks/objects/README.md#get) - Get an object
* [update](docs/sdks/objects/README.md#update) - Update an object
* [getViews](docs/sdks/objects/README.md#getviews) - List views for object

### [Records](docs/sdks/records/README.md)

* [query](docs/sdks/records/README.md#query) - List records
* [create](docs/sdks/records/README.md#create) - Create a record
* [assert](docs/sdks/records/README.md#assert) - Assert a record
* [get](docs/sdks/records/README.md#get) - Get a record
* [updateAppend](docs/sdks/records/README.md#updateappend) - Update a record (append multiselect values)
* [update](docs/sdks/records/README.md#update) - Update a record (overwrite multiselect values)
* [delete](docs/sdks/records/README.md#delete) - Delete a record
* [listAttributeValues](docs/sdks/records/README.md#listattributevalues) - List record attribute values
* [listEntries](docs/sdks/records/README.md#listentries) - List record entries
* [search](docs/sdks/records/README.md#search) - Search records

### [ScimGroups](docs/sdks/scimgroups/README.md)

* [list](docs/sdks/scimgroups/README.md#list) - List SCIM groups
* [create](docs/sdks/scimgroups/README.md#create) - Create SCIM group
* [patch](docs/sdks/scimgroups/README.md#patch) - Patch SCIM group
* [update](docs/sdks/scimgroups/README.md#update) - Update SCIM group

### [ScimSchemas](docs/sdks/scimschemas/README.md)

* [list](docs/sdks/scimschemas/README.md#list) - List SCIM schemas

### [ScimUsers](docs/sdks/scimusers/README.md)

* [list](docs/sdks/scimusers/README.md#list) - List SCIM users
* [create](docs/sdks/scimusers/README.md#create) - Create SCIM user
* [patch](docs/sdks/scimusers/README.md#patch) - Patch SCIM user
* [update](docs/sdks/scimusers/README.md#update) - Update SCIM user

### [Tasks](docs/sdks/tasks/README.md)

* [list](docs/sdks/tasks/README.md#list) - List tasks
* [create](docs/sdks/tasks/README.md#create) - Create a task
* [get](docs/sdks/tasks/README.md#get) - Get a task
* [update](docs/sdks/tasks/README.md#update) - Update a task
* [delete](docs/sdks/tasks/README.md#delete) - Delete a task

### [Threads](docs/sdks/threads/README.md)

* [listAll](docs/sdks/threads/README.md#listall) - List threads
* [get](docs/sdks/threads/README.md#get) - Get a thread

### [Transcripts](docs/sdks/transcripts/README.md)

* [getCallTranscript](docs/sdks/transcripts/README.md#getcalltranscript) - Get call transcript

### [Webhooks](docs/sdks/webhooks/README.md)

* [list](docs/sdks/webhooks/README.md#list) - List webhooks
* [create](docs/sdks/webhooks/README.md#create) - Create a webhook
* [get](docs/sdks/webhooks/README.md#get) - Get a webhook
* [update](docs/sdks/webhooks/README.md#update) - Update a webhook
* [delete](docs/sdks/webhooks/README.md#delete) - Delete a webhook

### [WorkspaceMembers](docs/sdks/workspacemembers/README.md)

* [list](docs/sdks/workspacemembers/README.md#list) - List workspace members
* [get](docs/sdks/workspacemembers/README.md#get) - Get a workspace member

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start Standalone functions [standalone-funcs] -->
## 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](./FUNCTIONS.md).

<details>

<summary>Available standalone functions</summary>

- [`attributesCreateNew`](docs/sdks/attributes/README.md#createnew) - Create an attribute
- [`attributesCreateStatus`](docs/sdks/attributes/README.md#createstatus) - Create a status
- [`attributesGet`](docs/sdks/attributes/README.md#get) - Get an attribute
- [`attributesListAll`](docs/sdks/attributes/README.md#listall) - List attributes
- [`attributesListStatuses`](docs/sdks/attributes/README.md#liststatuses) - List statuses
- [`attributesOptionsCreate`](docs/sdks/options/README.md#create) - Create a select option
- [`attributesOptionsList`](docs/sdks/options/README.md#list) - List select options
- [`attributesUpdate`](docs/sdks/attributes/README.md#update) - Update an attribute
- [`attributesUpdateSelectOption`](docs/sdks/attributes/README.md#updateselectoption) - Update a select option
- [`attributesUpdateStatus`](docs/sdks/attributes/README.md#updatestatus) - Update a status
- [`callRecordingsCreate`](docs/sdks/callrecordings/README.md#create) - Create call recording
- [`callRecordingsDelete`](docs/sdks/callrecordings/README.md#delete) - Delete call recording
- [`callRecordingsGet`](docs/sdks/callrecordings/README.md#get) - Get call recording
- [`callRecordingsList`](docs/sdks/callrecordings/README.md#list) - List call recordings
- [`commentsCreate`](docs/sdks/comments/README.md#create) - Create a comment
- [`commentsDelete`](docs/sdks/comments/README.md#delete) - Delete a comment
- [`commentsGet`](docs/sdks/comments/README.md#get) - Get a comment
- [`entriesAssert`](docs/sdks/entries/README.md#assert) - Assert a list entry by parent
- [`entriesCreate`](docs/sdks/entries/README.md#create) - Create an entry (add record to list)
- [`entriesDelete`](docs/sdks/entries/README.md#delete) - Delete a list entry
- [`entriesGet`](docs/sdks/entries/README.md#get) - Get a list entry
- [`entriesListAttributeValues`](docs/sdks/entries/README.md#listattributevalues) - List attribute values for a list entry
- [`entriesQuery`](docs/sdks/entries/README.md#query) - List entries
- [`entriesUpdate`](docs/sdks/entries/README.md#update) - Update a list entry (overwrite multiselect values)
- [`entriesUpdateAppending`](docs/sdks/entries/README.md#updateappending) - Update a list entry (append multiselect values)
- [`filesCreate`](docs/sdks/files/README.md#create) - Create a folder
- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete a file
- [`filesDownload`](docs/sdks/files/README.md#download) - Download a file
- [`filesGet`](docs/sdks/files/README.md#get) - Get a file
- [`filesList`](docs/sdks/files/README.md#list) - List files
- [`filesUpload`](docs/sdks/files/README.md#upload) - Upload a file
- [`listsCreate`](docs/sdks/lists/README.md#create) - Create a list
- [`listsGet`](docs/sdks/lists/README.md#get) - Get a list
- [`listsGetViews`](docs/sdks/lists/README.md#getviews) - List views for list
- [`listsList`](docs/sdks/lists/README.md#list) - List all lists
- [`listsUpdate`](docs/sdks/lists/README.md#update) - Update a list
- [`meetingsFindOrCreate`](docs/sdks/meetings/README.md#findorcreate) - Find or create a meeting
- [`meetingsGet`](docs/sdks/meetings/README.md#get) - Get a meeting
- [`meetingsList`](docs/sdks/meetings/README.md#list) - List meetings
- [`metaIdentify`](docs/sdks/meta/README.md#identify) - Identify
- [`notesCreate`](docs/sdks/notes/README.md#create) - Create a note
- [`notesDelete`](docs/sdks/notes/README.md#delete) - Delete a note
- [`notesGet`](docs/sdks/notes/README.md#get) - Get a note
- [`notesList`](docs/sdks/notes/README.md#list) - List notes
- [`objectsCreate`](docs/sdks/objects/README.md#create) - Create an object
- [`objectsGet`](docs/sdks/objects/README.md#get) - Get an object
- [`objectsGetViews`](docs/sdks/objects/README.md#getviews) - List views for object
- [`objectsList`](docs/sdks/objects/README.md#list) - List objects
- [`objectsUpdate`](docs/sdks/objects/README.md#update) - Update an object
- [`recordsAssert`](docs/sdks/records/README.md#assert) - Assert a record
- [`recordsCreate`](docs/sdks/records/README.md#create) - Create a record
- [`recordsDelete`](docs/sdks/records/README.md#delete) - Delete a record
- [`recordsGet`](docs/sdks/records/README.md#get) - Get a record
- [`recordsListAttributeValues`](docs/sdks/records/README.md#listattributevalues) - List record attribute values
- [`recordsListEntries`](docs/sdks/records/README.md#listentries) - List record entries
- [`recordsQuery`](docs/sdks/records/README.md#query) - List records
- [`recordsSearch`](docs/sdks/records/README.md#search) - Search records
- [`recordsUpdate`](docs/sdks/records/README.md#update) - Update a record (overwrite multiselect values)
- [`recordsUpdateAppend`](docs/sdks/records/README.md#updateappend) - Update a record (append multiselect values)
- [`scimGroupsCreate`](docs/sdks/scimgroups/README.md#create) - Create SCIM group
- [`scimGroupsList`](docs/sdks/scimgroups/README.md#list) - List SCIM groups
- [`scimGroupsPatch`](docs/sdks/scimgroups/README.md#patch) - Patch SCIM group
- [`scimGroupsUpdate`](docs/sdks/scimgroups/README.md#update) - Update SCIM group
- [`scimSchemasList`](docs/sdks/scimschemas/README.md#list) - List SCIM schemas
- [`scimUsersCreate`](docs/sdks/scimusers/README.md#create) - Create SCIM user
- [`scimUsersList`](docs/sdks/scimusers/README.md#list) - List SCIM users
- [`scimUsersPatch`](docs/sdks/scimusers/README.md#patch) - Patch SCIM user
- [`scimUsersUpdate`](docs/sdks/scimusers/README.md#update) - Update SCIM user
- [`tasksCreate`](docs/sdks/tasks/README.md#create) - Create a task
- [`tasksDelete`](docs/sdks/tasks/README.md#delete) - Delete a task
- [`tasksGet`](docs/sdks/tasks/README.md#get) - Get a task
- [`tasksList`](docs/sdks/tasks/README.md#list) - List tasks
- [`tasksUpdate`](docs/sdks/tasks/README.md#update) - Update a task
- [`threadsGet`](docs/sdks/threads/README.md#get) - Get a thread
- [`threadsListAll`](docs/sdks/threads/README.md#listall) - List threads
- [`transcriptsGetCallTranscript`](docs/sdks/transcripts/README.md#getcalltranscript) - Get call transcript
- [`webhooksCreate`](docs/sdks/webhooks/README.md#create) - Create a webhook
- [`webhooksDelete`](docs/sdks/webhooks/README.md#delete) - Delete a webhook
- [`webhooksGet`](docs/sdks/webhooks/README.md#get) - Get a webhook
- [`webhooksList`](docs/sdks/webhooks/README.md#list) - List webhooks
- [`webhooksUpdate`](docs/sdks/webhooks/README.md#update) - Update a webhook
- [`workspaceMembersGet`](docs/sdks/workspacemembers/README.md#get) - Get a workspace member
- [`workspaceMembersList`](docs/sdks/workspacemembers/README.md#list) - List workspace members

</details>
<!-- End Standalone functions [standalone-funcs] -->

<!-- Start File uploads [file-upload] -->
## File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]
>
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
>
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).

```typescript
import { Attio } from "@interfere/attio";
import { openAsBlob } from "node:fs";

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

async function run() {
  const result = await attio.files.upload({
    file: await openAsBlob("example.file"),
    object: "people",
    recordId: "bf071e1f-6035-429d-b874-d83ea64ea13b",
    parentFolderId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  });

  console.log(result);
}

run();

```
<!-- End File uploads [file-upload] -->

<!-- Start Retries [retries] -->
## 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:
```typescript
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:
```typescript
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();

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`AttioBaseError`](./src/models/errors/attio-base-error.ts) 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](#error-classes). |

### Example
```typescript
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.CreateObjectSlugConflictError) {
        console.log(error.data$.statusCode); // operations.CreateObjectStatusCode
        console.log(error.data$.type); // operations.CreateObjectType
        console.log(error.data$.code); // operations.CreateObjectCode
        console.log(error.data$.message); // string
      }
    }
  }
}

run();

```

### Error Classes
**Primary error:**
* [`AttioBaseError`](./src/models/errors/attio-base-error.ts): The base class for HTTP error responses.

<details><summary>Less common errors (96)</summary>

<br />

**Network errors:**
* [`ConnectionError`](./src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.


**Inherit from [`AttioBaseError`](./src/models/errors/attio-base-error.ts)**:
* [`UpdateObjectValidationTypeError`](./src/models/errors/update-object-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateNewAttributeValidationTypeError`](./src/models/errors/create-new-attribute-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`SystemEditUnauthorizedError`](./src/models/errors/system-edit-unauthorized-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateAttributeSelectOptionValueNotFoundError`](./src/models/errors/update-attribute-select-option-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateAttributeStatusValidationTypeError`](./src/models/errors/create-attribute-status-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateAttributeStatusValueNotFoundError`](./src/models/errors/update-attribute-status-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`FilterError`](./src/models/errors/filter-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateRecordValueNotFoundError`](./src/models/errors/create-record-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`AssertRecordValueNotFoundError`](./src/models/errors/assert-record-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateAppendRecordMissingValueError`](./src/models/errors/update-append-record-missing-value-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateRecordMissingValueError`](./src/models/errors/update-record-missing-value-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`ListRecordAttributeValuesValidationTypeError`](./src/models/errors/list-record-attribute-values-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`SearchRecordsValueNotFoundError`](./src/models/errors/search-records-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateListValueNotFoundError`](./src/models/errors/create-list-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateListValueNotFoundError`](./src/models/errors/update-list-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateEntryValueNotFoundError`](./src/models/errors/create-entry-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`MultipleMatchResultsError`](./src/models/errors/multiple-match-results-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateAppendingEntryImmutableValueError`](./src/models/errors/update-appending-entry-immutable-value-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateEntryImmutableValueError`](./src/models/errors/update-entry-immutable-value-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateTaskValidationTypeError`](./src/models/errors/create-task-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`UpdateTaskValidationTypeError`](./src/models/errors/update-task-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateCommentValueNotFoundError`](./src/models/errors/create-comment-value-not-found-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`FindOrCreateMeetingValidationTypeError`](./src/models/errors/find-or-create-meeting-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateCallRecordingValidationTypeError`](./src/models/errors/create-call-recording-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateWebhookValidationTypeError`](./src/models/errors/create-webhook-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`CreateAttributeOptionValidationTypeError`](./src/models/errors/create-attribute-option-validation-type-error.ts): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
* [`BillingError`](./src/models/errors/billing-error.ts): Forbidden. Status code `403`. Applicable to 1 of 83 methods.*
* [`AuthError`](./src/models/errors/auth-error.ts): Forbidden. Status code `403`. Applicable to 1 of 83 methods.*
* [`GetObjectNotFoundError`](./src/models/errors/get-object-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateObjectNotFoundError`](./src/models/errors/update-object-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetObjectViewsNotFoundError`](./src/models/errors/get-object-views-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateNewAttributeNotFoundError`](./src/models/errors/create-new-attribute-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetAttributeNotFoundError`](./src/models/errors/get-attribute-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateAttributeNotFoundError`](./src/models/errors/update-attribute-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateAttributeSelectOptionNotFoundError`](./src/models/errors/update-attribute-select-option-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`ListAttributeStatusesNotFoundError`](./src/models/errors/list-attribute-statuses-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateAttributeStatusNotFoundError`](./src/models/errors/create-attribute-status-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateAttributeStatusNotFoundError`](./src/models/errors/update-attribute-status-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`QueryRecordsNotFoundError`](./src/models/errors/query-records-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateRecordNotFoundError`](./src/models/errors/create-record-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`AssertRecordNotFoundError`](./src/models/errors/assert-record-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetRecordNotFoundError`](./src/models/errors/get-record-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateAppendRecordNotFoundError`](./src/models/errors/update-append-record-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateRecordNotFoundError`](./src/models/errors/update-record-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteRecordNotFoundError`](./src/models/errors/delete-record-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`ListRecordAttributeValuesNotFoundError`](./src/models/errors/list-record-attribute-values-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateListNotFoundError`](./src/models/errors/create-list-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetListNotFoundError`](./src/models/errors/get-list-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateListNotFoundError`](./src/models/errors/update-list-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetListViewsNotFoundError`](./src/models/errors/get-list-views-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`QueryEntriesNotFoundError`](./src/models/errors/query-entries-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateEntryNotFoundError`](./src/models/errors/create-entry-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`AssertEntryNotFoundError`](./src/models/errors/assert-entry-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetEntryNotFoundError`](./src/models/errors/get-entry-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateAppendingEntryNotFoundError`](./src/models/errors/update-appending-entry-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateEntryNotFoundError`](./src/models/errors/update-entry-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteEntryNotFoundError`](./src/models/errors/delete-entry-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`ListEntryAttributeValuesNotFoundError`](./src/models/errors/list-entry-attribute-values-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetWorkspaceMemberNotFoundError`](./src/models/errors/get-workspace-member-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`ListNotesNotFoundError`](./src/models/errors/list-notes-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateNoteNotFoundError`](./src/models/errors/create-note-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetNoteNotFoundError`](./src/models/errors/get-note-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteNoteNotFoundError`](./src/models/errors/delete-note-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateTaskNotFoundError`](./src/models/errors/create-task-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetTaskNotFoundError`](./src/models/errors/get-task-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateTaskNotFoundError`](./src/models/errors/update-task-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteTaskNotFoundError`](./src/models/errors/delete-task-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetThreadNotFoundError`](./src/models/errors/get-thread-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetCommentNotFoundError`](./src/models/errors/get-comment-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteCommentNotFoundError`](./src/models/errors/delete-comment-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetMeetingNotFoundError`](./src/models/errors/get-meeting-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateCallRecordingNotFoundError`](./src/models/errors/create-call-recording-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetCallRecordingNotFoundError`](./src/models/errors/get-call-recording-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteCallRecordingNotFoundError`](./src/models/errors/delete-call-recording-not-found-error.ts): Call recording not found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetFileNotFoundError`](./src/models/errors/get-file-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteFileNotFoundError`](./src/models/errors/delete-file-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`GetWebhookNotFoundError`](./src/models/errors/get-webhook-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`UpdateWebhookNotFoundError`](./src/models/errors/update-webhook-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`DeleteWebhookNotFoundError`](./src/models/errors/delete-webhook-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`ListAttributeOptionsNotFoundError`](./src/models/errors/list-attribute-options-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateAttributeOptionNotFoundError`](./src/models/errors/create-attribute-option-not-found-error.ts): Not Found. Status code `404`. Applicable to 1 of 83 methods.*
* [`CreateObjectSlugConflictError`](./src/models/errors/create-object-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`UpdateObjectSlugConflictError`](./src/models/errors/update-object-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`CreateNewAttributeSlugConflictError`](./src/models/errors/create-new-attribute-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`UpdateAttributeSelectOptionSlugConflictError`](./src/models/errors/update-attribute-select-option-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`CreateAttributeStatusSlugConflictError`](./src/models/errors/create-attribute-status-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`UpdateAttributeStatusSlugConflictError`](./src/models/errors/update-attribute-status-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`CreateListSlugConflictError`](./src/models/errors/create-list-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`CreateAttributeOptionSlugConflictError`](./src/models/errors/create-attribute-option-slug-conflict-error.ts): Conflict. Status code `409`. Applicable to 1 of 83 methods.*
* [`CreateNoteValidationTypeError`](./src/models/errors/create-note-validation-type-error.ts): Content Too Large. Status code `413`. Applicable to 1 of 83 methods.*
* [`ResponseValidationError`](./src/models/errors/response-validation-error.ts): 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.

</details>

\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## 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:
```typescript
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();

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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](https://www.npmjs.com/package/undici)'s ProxyAgent
- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
- use the `"requestError"` hook to log errors

```typescript
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 });
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Debugging [debug] -->
## 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.

```typescript
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.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

# 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](https://www.speakeasy.com/?utm_source=@interfere/attio&utm_campaign=typescript)