Skip to content

Commit fab0e1e

Browse files
committed
bump version to 2.11.1
1 parent 48e4dc8 commit fab0e1e

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,41 @@
11
# intercom-node
2-
> Official Node bindings to the Intercom API
32

4-
[![Circle CI](https://circleci.com/gh/intercom/intercom-node.png?style=badge)](https://circleci.com/gh/intercom/intercom-node)
3+
[![Circle CI](https://circleci.com/gh/intercom/intercom-node.png?style=shield)](https://circleci.com/gh/intercom/intercom-node)
4+
[![npm](https://img.shields.io/npm/v/intercom-client)](https://www.npmjs.com/package/intercom-client)
5+
![Intercom API Version](https://img.shields.io/badge/Intercom%20API%20Version-1.3-blue)
56

6-
[![npm version](https://badge.fury.io/js/intercom-client.svg)](http://badge.fury.io/js/intercom-client)
7+
> Official Node bindings to the [Intercom API](https://api.intercom.io/docs)
78
8-
### Excluding Customer Search (2.0), only supports 1.X
9+
## Project Updates
910

10-
## Installation
11+
### Maintenance
12+
13+
We're currently building a new team to provide in-depth and dedicated SDK support.
14+
15+
In the meantime, we'll be operating on limited capacity, meaning all pull requests will be evaluated on a best effort basis and will be limited to critical issues.
1116

12-
[![docker_image 1](https://cloud.githubusercontent.com/assets/15954251/17524401/5743439e-5e56-11e6-8567-d3d9da1727da.png)](https://hub.docker.com/r/intercom/sdk-images/) <br>
13-
Try out our [Docker Image (Beta)](https://hub.docker.com/r/intercom/sdk-images/) to help you get started more quickly. <br>
14-
It should make it easier to get setup with the SDK and start interacting with the API. <br>
15-
(Note, this is in Beta and is for testing purposes only, it should not be used in production)
17+
We'll communicate all relevant updates as we build this new team and support strategy in the coming months.
18+
19+
## Installation
1620

1721
```bash
18-
npm install intercom-client
22+
yarn add intercom-client
1923
```
2024

2125
**This client is intended for server side use only. Please use the [Intercom Javascript SDK](https://developers.intercom.com/v2.0/docs/intercom-javascript) for client-side operations.**
2226

2327
## Testing
2428

2529
```bash
26-
npm test
30+
yarn test
2731
```
2832

2933
## Running the code locally
3034

3135
Compile using babel:
3236

3337
```bash
34-
gulp babel
38+
yarn gulp babel
3539
```
3640

3741
Require Intercom:
@@ -48,8 +52,7 @@ Require Intercom:
4852
var Intercom = require('intercom-client');
4953
```
5054

51-
Create a client:
52-
#### Using Access Tokens
55+
Create a client using access tokens:
5356

5457
```node
5558
var client = new Intercom.Client({ token: 'my_token' });
@@ -63,9 +66,11 @@ This client library supports two kinds of callbacks:
6366
client.users.list(function (d) {
6467
// d is the response from the server
6568
});
69+
```
6670

67-
// Or
71+
Or
6872

73+
```node
6974
client.users.list(function (err, d) {
7075
// err is an error response object, or null
7176
// d is a successful response object, or null
@@ -97,7 +102,7 @@ client.useRequestOpts({
97102

98103
Note that certain request options (such as `json`, and certain `headers` names cannot be overriden).
99104

100-
#### Setting the API version
105+
### Setting the API version
101106

102107
We version our API (see the "Choose Version" section of the [API & Webhooks Reference](https://developers.intercom.com/intercom-api-reference/reference) for details). You can specify which version of the API to use when performing API requests using request options:
103108

@@ -238,7 +243,6 @@ client.leads.scroll.each({}, function(res) {
238243
client.leads.listBy({ email: '[email protected]' }, callback);
239244
```
240245

241-
242246
```node
243247
// Find contact by id
244248
client.leads.find({ id: '5342423' }, callback);
@@ -306,7 +310,6 @@ var conversion = {
306310
client.visitors.convert(conversion, callback);
307311
```
308312

309-
310313
## Companies
311314

312315
```node
@@ -341,7 +344,6 @@ client.companies.scroll.each({}, function(res) {
341344
});
342345
```
343346

344-
345347
```node
346348
// Find company by id
347349
client.companies.find({ id: '1234' }, callback);
@@ -353,7 +355,6 @@ client.companies.listUsers({ id: '1234' }, callback);
353355
client.companies.listUsers({ company_id: '1234' }, callback);
354356
```
355357

356-
357358
## Events
358359

359360
Note: events will work when identified by 'email'. The `event_name` and `created_at` params are both required. Either `user_id` OR `email` is required.
@@ -410,12 +411,12 @@ client.admins.list(callback);
410411
client.admins.me(callback);
411412
```
412413

413-
```
414+
```node
414415
// Find admin by ID
415416
client.admins.find('123456789', callback);
416417
```
417418

418-
```
419+
```node
419420
// Update admin away mode and reassign settings
420421
client.admins.away('123456789', {'away_mode_enabled': true, 'away_mode_reassign': false}, callback);
421422
```
@@ -508,7 +509,6 @@ Listing conversations ([documentation](https://developers.intercom.com/intercom-
508509
client.conversations.list({ type: 'admin', admin_id: 21599 }, callback);
509510
```
510511

511-
512512
```node
513513
// Fetch a conversation
514514
client.conversations.find({ id: '1062682196' }, callback);
@@ -625,7 +625,6 @@ IdentityVerification.userHash({secretKey: 's3cre7', identifier: 'jayne@serenity.
625625

626626
Apache-2.0
627627

628-
629628
## Pull Requests
630629

631630
- **Add tests!** Your patch won't be accepted if it doesn't have tests.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "intercom-client",
3-
"version": "2.11.0",
3+
"version": "2.11.1",
44
"description": "Official Node bindings to the Intercom API",
55
"homepage": "https://github.com/intercom/intercom-node",
66
"bugs:": "https://github.com/intercom/intercom-node/issues",
@@ -31,6 +31,7 @@
3131
"eslint": "^6.8.0",
3232
"gulp": "^4.0.2",
3333
"gulp-babel": "^8.0.0",
34+
"gulp-cli": "^2.2.0",
3435
"gulp-eslint": "4.0.2",
3536
"gulp-exclude-gitignore": "^1.0.0",
3637
"gulp-istanbul": "^1.1.3",

0 commit comments

Comments
 (0)