README.mkd in assistly-0.2.5 vs README.mkd in assistly-0.2.6
- old
+ new
@@ -4,13 +4,17 @@
Installation
------------
gem install assistly
+What's new in 0.2.6?
+------------------
+Newer faraday, faraday_middleware and multixml versions
+
What's new in 0.2.5?
------------------
-Newer MultiJson
+Newer multijson version for Rails 3.1 compatibility
What's new in 0.2.4?
------------------
Resolved an issue that was breaking PUT requests.
@@ -18,11 +22,11 @@
------------------
Removed deep_merge because it conflicts with rails. Handling the merge inside the create_outbound_interaction method only on headers for now, until we need it elsewhere.
What's new in 0.2.2?
------------------
-Added deep_merge support so that we keep any custom email headers when creating outbound interactions.
+Added deep_merge support so that we keep any custom email headers when creating outbound interactions.
Required pony in the gem so you don't have to include it in your app.
What's new in 0.2.1?
------------------
Stopped returning only the 'results' array when listing things, because this would cause us to not have access to page numbers, total counts, etc.
@@ -76,11 +80,11 @@
# Update a specific case
Assistly.update_case(12345, :subject => "Something Else")
# Get a case url
Assistly.case_url(12345)
-
+
######
# Customers
######
# List customers
@@ -101,11 +105,11 @@
Assistly.create_customer_email(12345, "foo@example.com", :customer_contact_type => "work")
# Update a customer email
Assistly.update_customer_email(12345, 54321, :email => "foo@example.com")
Assistly.update_customer_email(12345, 54321, :customer_contact_type => "work")
-
+
######
# Interactions
######
# List interactions
@@ -114,15 +118,15 @@
Assistly.interactions(:since_id => 12345, :count => 5)
# Create an inbound interaction
Assistly.create_interaction(:interaction_subject => "help me", :customer_email => "foo@example.com", :interaction_body => "You're my only hope.")
Assistly.create_inbound_interaction(:interaction_subject => "help me", :customer_email => "foo@example.com", :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 => "foo@example.com", :interaction_body => "Sorry we missed yoru call. What's up?", :direction => "outbound")
@@ -135,53 +139,53 @@
# 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)
@@ -192,16 +196,16 @@
# 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")
Contributing
------------