https://github.com/intercom/intercom-node
Node.js bindings for the Intercom API
https://github.com/intercom/intercom-node
api intercom sdk
Last synced: 29 days ago
JSON representation
Node.js bindings for the Intercom API
- Host: GitHub
- URL: https://github.com/intercom/intercom-node
- Owner: intercom
- License: other
- Created: 2014-09-16T14:21:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T08:33:13.000Z (6 months ago)
- Last Synced: 2024-12-17T15:47:26.945Z (5 months ago)
- Topics: api, intercom, sdk
- Language: TypeScript
- Homepage: https://developers.intercom.com
- Size: 2.89 MB
- Stars: 368
- Watchers: 172
- Forks: 118
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Intercom TypeScript Library
[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fintercom%2Fintercom-node)
[](https://www.npmjs.com/package/intercom-client)
The Intercom TypeScript library provides convenient access to the Intercom API from TypeScript.
## Project Updates
The TypeScript SDK has been updated to support latest API version (2.11).
## Installation
```sh
npm i -s intercom-client
```
## Reference
A full reference for this library is available [here](./reference.md).
## Usage
Instantiate and use the client with the following:
```typescript
import { IntercomClient } from "intercom-client";
const client = new IntercomClient({ token: "YOUR_TOKEN" });
await client.articles.create({
title: "Thanks for everything",
description: "Description of the Article",
body: "Body of the Article",
author_id: 1295,
state: "published",
});
```
## Request And Response Types
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
following namespace:
```typescript
import { Intercom } from "intercom-client";
const request: Intercom.ConfigureAwayAdminRequest = {
...
};
```
## Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
will be thrown.
```typescript
import { IntercomError } from "intercom-client";
try {
await client.articles.create(...);
} catch (err) {
if (err instanceof IntercomError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
}
}
```
## Pagination
List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
```typescript
import { IntercomClient } from "intercom-client";
const client = new IntercomClient({ token: "YOUR_TOKEN" });
const response = await client.articles.list();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
const page = await client.articles.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
## Advanced
### Additional Headers
If you would like to send additional headers as part of the request, use the `headers` request option.
```typescript
const response = await client.articles.create(..., {
headers: {
'X-Custom-Header': 'custom value'
}
});
```
### Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
Use the `maxRetries` request option to configure this behavior.
```typescript
const response = await client.articles.create(..., {
maxRetries: 0 // override maxRetries at the request level
});
```
### Timeouts
The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
```typescript
const response = await client.articles.create(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
```
### Aborting Requests
The SDK allows users to abort requests at any point by passing in an abort signal.
```typescript
const controller = new AbortController();
const response = await client.articles.create(..., {
abortSignal: controller.signal
});
controller.abort(); // aborts the request
```
### Runtime Compatibility
The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
runtimes:
- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native
### Customizing Fetch Client
The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
unsupported environment, this provides a way for you to break glass and ensure the SDK works.
```typescript
import { IntercomClient } from "intercom-client";
const client = new IntercomClient({
...
fetcher: // provide your implementation here
});
```
## Contributing
While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
## Request Options
This client library also supports passing in [`request` options](https://github.com/axios/axios#request-config):
```typescript
client.useRequestOpts({
baseURL: "http://local.test-server.com",
});
```
Note that certain request options (such as `json`, and certain `headers` names cannot be overriden).
### Setting the API base url
If you are using the european instance of intercom and would like to call it directly and not be redirected through our US instance, you can set the `baseUrl` as follows:
```typescript
client.useRequestOpts({
baseURL: "https://api.eu.intercom.io",
});
```