python-intercom¶
Installation¶
Stable releases of python-intercom can be installed with pip or you may download a .tgz source archive from pypi. See the Installation page for more detailed instructions.
If you want to use the latest code, you can grab it from our Git repository, or fork it.
Usage¶
Authentication¶
Intercom documentation: Authentication.
from intercom import Intercom
Intercom.app_id = 'dummy-app-id'
Intercom.api_key = 'dummy-api-key'
Users¶
Getting all Users¶
Intercom documentation: Getting all Users.
from intercom import User
for user in User.all():
print user.email
Create a User¶
Intercom documentation: Create a User.
user = User.create(email="ben@intercom.io",
user_id=7902,
name="Ben McRedmond",
created_at=datetime.now(),
custom_data={"plan": "pro"},
last_seen_ip="1.2.3.4",
last_seen_user_agent="ie6")
Updating a User¶
Intercom documentation: Updating a User.
user = User.find(email="ben@intercom.io")
user.name = "Benjamin McRedmond"
user.save()
Deleting a User¶
Intercom documentation: Deleting a User.
deleted_user = User.delete(email="ben@intercom.io")
Notes¶
Creating a Note¶
Intercom documentation: Creating a Note.
from intercom import Note
note = Note.create(email="ben@intercom.io",
body="These are a few of my favourite things.")
Tagging¶
Getting a Tag¶
Intercom documentation: Getting a Tag.
from intercom import Tag
tag = Tag.find_by_name("Free Trial")
Creating a new Tag¶
Intercom documentation: Creating a new Tag.
from intercom import Tag
tag = Tag.create("Free Trial")
Updating an already existing Tag¶
Intercom documentation: Updating a Tag.
from intercom import Tag
tag = Tag.update("Free Trial", "tag",
user_ids=["abc123", "def456"])
Impressions¶
Creating an Impression¶
Intercom documentation: Creating an Impression.
from intercom import Impression
impression = Impression.create(email="ben@intercom.io",
user_agent="my-awesome-android-app-v0.0.1")
Message Threads¶
Getting Message Threads¶
Intercom documentation: Getting Message Threads.
from intercom import MessageThread
# all message threads
message_threads = MessageThread.find_all(email="ben@intercom.io")
# a specific thread
message_threads = MessageThread.find_all(email="ben@intercom.io",
thread_id=123)
Creating a Message Thread¶
Intercom documentation: Creating a Message Thread.
message_thread = MessageThread.create(email="ben@intercom.io",
body="Hey Intercom, What is up?")
Replying on a Message Thread¶
Intercom documentation: Replying on a Message Thread.
message_thread = MessageThread.create(email="ben@intercom.io",
thread_id=123,
body="Not much either :(")
Events¶
Submitting Events¶
Intercom documentation: Submitting Events.
from intercom import Event
impression = Event.create(event_name="sent-invite",
user_id="314159")
Development¶
Our Development page has detailed instructions on how to run our tests, and to produce coverage and pylint reports.