gem install assistly

require "rubygems"
require "assistly"

# All methods require authentication. To get your Assistly OAuth credentials,
# register an app in the Assistly admin for your account at http://your-domain.assistly.com/admin
@assistly = Assistly.configure do |config|
  config.support_email = "[email protected]"
  config.subdomain = YOUR_ASSISTLY_SUBDOMAIN
  config.consumer_key = YOUR_CONSUMER_KEY
  config.consumer_secret = YOUR_CONSUMER_SECRET
  config.oauth_token = YOUR_OAUTH_TOKEN
  config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
end

######
# Cases
######

# List cases
@assistly.cases
@assistly.cases(:since_id => 12345)

# Get a specific case
@assistly.case(12345)

# Update a specific case
@assistly.update_case(12345, :subject => "Something Else")

# Get a case url
@assistly.case_url(12345)

######
# Customers
######

# List customers
@assistly.customers
@assistly.customers(:since_id => 12345, :count => 5)

# Get a specific customer
@assistly.customer(12345)

# Create a customer
@assistly.create_customer(:name => "Chris Warren", :twitter => "cdwarren")

# Update a customer
@assistly.update_customer(12345, :name => "Christopher Warren")

# Add a customer email
@assistly.create_customer_email(12345, "[email protected]")
@assistly.create_customer_email(12345, "[email protected]", :customer_contact_type => "work")

# Update a customer email
@assistly.update_customer_email(12345, 54321, :email => "[email protected]")
@assistly.update_customer_email(12345, 54321, :customer_contact_type => "work")

######
# Interactions
######

# List interactions
@assistly.interactions
@assistly.interactions(:since_id => 12345)
@assistly.interactions(:since_id => 12345, :count => 5)

# Create an inbound interaction
@assistly.create_interaction(:interaction_subject => "help me", :customer_email => "[email protected]", :interaction_body => "You're my only hope.")
@assistly.create_inbound_interaction(:interaction_subject => "help me", :customer_email => "[email protected]", :interaction_body => "You're my only hope.")

# Create an outbound interaction
# Assistly's API doesn't support creating outbound communications, so we do this over email with a BCC back to Assistly and customer headers.
# Assistly.support_email must be set to your Assistly email address so that the email can be sent to the account and give the customer someone to respond to.
# 
# Read more at http://support.assistly.com/customer/portal/articles/4180
# Additional headers can be passed as well http://support.assistly.com/customer/portal/articles/6728
#
# Email is sent using Pony https://github.com/benprew/pony
@assistly.create_interaction(:interaction_subject => "Missed Your Call", :customer_email => "[email protected]", :interaction_body => "Sorry we missed yoru call. What's up?", :direction => "outbound")
@assistly.create_outbound_interaction("[email protected]", "Missed Your Call", "Sorry we missed yoru call. What's up?")

######
# Users
######

# List users
@assistly.users

# Get a specific user
@assistly.user(12345)

######
# Topics
######

# List Topics
@assistly.topics

# Get a specific topic
@assistly.topic(12345)

# Create a new topic
@assistly.create_topic("name", :description => "description")

# Update a topic
@assistly.update_topic(12345, :subject => "Updated")

# Delete a topic
@assistly.delete_topic(12345)

######
# Articles
######

# List articles for a topic
@assistly.articles(1)

# Get a specific article
@assistly.article(12345)

# Create a new article within a topic
@assistly.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API")

# Update an article
@assistly.update_article(12345, :subject => "Updated API Tips")

# Delete an article
@assistly.delete_article(12345)

######
# Macros
######

# List Macros
@assistly.macros

# Get a specific macro
@assistly.macro(12345)

# Create a new macro
@assistly.create_macro("name", :labels => "escalated")

# Update a macro
@assistly.update_macro(12345, :name => "Updated Name")

# Delete a macro
@assistly.delete_macro(12345)

# Macro Actions
@assistly.macro_actions(12345)

# Macro Action
@assistly.macro_action(12345, "set-case-description")

# Update Macro Action
@assistly.update_macro_action(12345, "set-case-description", :value => "New Subject")