README.mkd in assistly-0.1.5 vs README.mkd in assistly-0.2.0

- old
+ new

@@ -1,13 +1,22 @@ The Assistly Ruby Gem ==================== -A Ruby wrapper for the Assistly API +A Ruby wrapper for the [Assistly API](http://dev.assistly.com/) Installation ------------ gem install assistly +What's new in 0.2.0? +------------------ +Added support for Topics, Articles, and Macros, which is currently all that is available in the Assistly API. + +What's new in 0.1.5? +------------------ +Added the ability to create outbound communications over email + + What's new in 0.1? ------------------ This is the first release of the Assistly gem, based on the [Twitter gem](http://github.com/jnunemaker/twitter). Support for most of the [Assistly API](http://dev.assistly.com/docs/api) are handled. There is not yet support for Content or Macros. @@ -22,17 +31,22 @@ 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 = "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 config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET end + ###### + # Cases + ###### + # List cases @assistly.cases @assistly.cases(:since_id => 12345) # Get a specific case @@ -41,10 +55,14 @@ # 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) @@ -62,10 +80,14 @@ @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 @assistly.interactions @assistly.interactions(:since_id => 12345) @assistly.interactions(:since_id => 12345, :count => 5) @@ -83,16 +105,86 @@ # # 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?") + ###### + # 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") + Contributing ------------ In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project. Here are some ways *you* can contribute: @@ -131,7 +223,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 +Copyright (c) 2011 Chris Warren/[Zencoder](http://zencoder.com) See [LICENSE](https://github.com/zencoder/assistly/blob/master/LICENSE.mkd) for details.