Sha256: 76cbcbb138d73c6e609f361ead6eff37918d28dcf2199be136615b1158c41549

Contents?: true

Size: 945 Bytes

Versions: 1

Compression:

Stored size: 945 Bytes

Contents

Ruby bindings for the Intercom API (https://api.intercom.io). See http://docs.intercom.io/api for more details

## Install
```
gem install intercom
```

## Basic Usage

### Configure your access credentials

```
Intercom.app_id = "my_app_iddd"
Intercom.api_key = "my-super-crazy-api-key"
```

### Resources

The API supports:

```
POST,PUT,GET https://api.intercom.io/v1/users
POST,PUT,GET https://api.intercom.io/v1/users/messages
POST https://api.intercom.io/v1/users/impressions
```

#### Users

```ruby
user = Intercom::User.find(:email => "bob@example.com")
user = Intercom::User.create(params)
user = Intercom::User.new(params)
user.save
```

#### Messages

```ruby
Intercom::Message.create
Intercom::Message.find
Intercom::Message.find_all
Intercom::Message.mark_as_read
```

#### Impressions

```ruby
Intercom::Impression.create
```

### Errors

```ruby
Intercom::AuthenticationError
Intercom::ServerError
Intercom::ResourceNotFound
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
intercom-0.0.3 README.md