README.mkd in assistly-0.2.4 vs README.mkd in assistly-0.2.5

- old
+ new

@@ -4,10 +4,18 @@ Installation ------------ gem install assistly +What's new in 0.2.5? +------------------ +Newer MultiJson + +What's new in 0.2.4? +------------------ +Resolved an issue that was breaking PUT requests. + What's new in 0.2.3? ------------------ 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? @@ -43,11 +51,11 @@ 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| + Assistly.configure do |config| config.support_email = "help@example.com" config.subdomain = YOUR_ASSISTLY_SUBDOMAIN config.consumer_key = YOUR_CONSUMER_KEY config.consumer_secret = YOUR_CONSUMER_SECRET config.oauth_token = YOUR_OAUTH_TOKEN @@ -57,146 +65,146 @@ ###### # Cases ###### # List cases - @assistly.cases - @assistly.cases(:since_id => 12345) + Assistly.cases + Assistly.cases(:since_id => 12345) # Get a specific case - @assistly.case(12345) + Assistly.case(12345) # Update a specific case - @assistly.update_case(12345, :subject => "Something Else") + Assistly.update_case(12345, :subject => "Something Else") # Get a case url - @assistly.case_url(12345) + Assistly.case_url(12345) ###### # Customers ###### # List customers - @assistly.customers - @assistly.customers(:since_id => 12345, :count => 5) + Assistly.customers + Assistly.customers(:since_id => 12345, :count => 5) # Get a specific customer - @assistly.customer(12345) + Assistly.customer(12345) # Create a customer - @assistly.create_customer(:name => "Chris Warren", :twitter => "cdwarren") + Assistly.create_customer(:name => "Chris Warren", :twitter => "cdwarren") # Update a customer - @assistly.update_customer(12345, :name => "Christopher Warren") + Assistly.update_customer(12345, :name => "Christopher Warren") # Add a customer email - @assistly.create_customer_email(12345, "foo@example.com") - @assistly.create_customer_email(12345, "foo@example.com", :customer_contact_type => "work") + Assistly.create_customer_email(12345, "foo@example.com") + 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") + Assistly.update_customer_email(12345, 54321, :email => "foo@example.com") + 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) + 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 => "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.") + 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") - @assistly.create_outbound_interaction("foo@example.com", "Missed Your Call", "Sorry we missed yoru call. What's up?") + 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") + Assistly.create_outbound_interaction("foo@example.com", "Missed Your Call", "Sorry we missed yoru call. What's up?") ###### # Users ###### # List users - @assistly.users + Assistly.users # Get a specific user - @assistly.user(12345) + Assistly.user(12345) ###### # Topics ###### # List Topics - @assistly.topics + Assistly.topics # Get a specific topic - @assistly.topic(12345) + Assistly.topic(12345) # Create a new topic - @assistly.create_topic("name", :description => "description") + Assistly.create_topic("name", :description => "description") # Update a topic - @assistly.update_topic(12345, :subject => "Updated") + Assistly.update_topic(12345, :subject => "Updated") # Delete a topic - @assistly.delete_topic(12345) + Assistly.delete_topic(12345) ###### # Articles ###### # List articles for a topic - @assistly.articles(1) + Assistly.articles(1) # Get a specific article - @assistly.article(12345) + Assistly.article(12345) # Create a new article within a topic - @assistly.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API") + 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") + Assistly.update_article(12345, :subject => "Updated API Tips") # Delete an article - @assistly.delete_article(12345) + Assistly.delete_article(12345) ###### # Macros ###### # List Macros - @assistly.macros + Assistly.macros # Get a specific macro - @assistly.macro(12345) + Assistly.macro(12345) # Create a new macro - @assistly.create_macro("name", :labels => "escalated") + Assistly.create_macro("name", :labels => "escalated") # Update a macro - @assistly.update_macro(12345, :name => "Updated Name") + Assistly.update_macro(12345, :name => "Updated Name") # Delete a macro - @assistly.delete_macro(12345) + Assistly.delete_macro(12345) # Macro Actions - @assistly.macro_actions(12345) + Assistly.macro_actions(12345) # Macro Action - @assistly.macro_action(12345, "set-case-description") + Assistly.macro_action(12345, "set-case-description") # Update Macro Action - @assistly.update_macro_action(12345, "set-case-description", :value => "New Subject") + Assistly.update_macro_action(12345, "set-case-description", :value => "New Subject") Contributing ------------ In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project. @@ -236,7 +244,7 @@ 8. Commit and push your changes. 9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.) Copyright --------- -Copyright (c) 2011 Chris Warren / [Zencoder, Inc](http://zencoder.com) +Copyright (c) 2011 Chris Warren/[Zencoder](http://zencoder.com) See [LICENSE](https://github.com/zencoder/assistly/blob/master/LICENSE.mkd) for details.