README.rdoc in ruby-pardot-1.0 vs README.rdoc in ruby-pardot-1.0.2
- old
+ new
@@ -18,10 +18,11 @@
=== Object Types
The available objects are:
+* emails
* lists
* opportunities
* prospects
* users
* visitor_activities
@@ -52,10 +53,19 @@
prospect.each do |key, value|
puts "#{key} is #{value}"
end
+=== Emails
+
+See each individual call's [API reference page](http://developer.pardot.com/kb/api-version-3/introduction-table-of-contents).
+
+ # Sample usage
+ @pardot.emails.read_by_id(email_id)
+ @pardot.emails.send_to_list(:email_template_id => template_id, 'list_ids[]' => list_id, :campaign_id => campaign_id)
+ @pardot.emails.send_to_prospect(prospect_id, :campaign_id => campaign_id, :email_template_id => template_id)
+
=== Output formats
client.format = "simple" # default
client.format = "mobile"
client.format = "full"
@@ -77,6 +87,23 @@
rescue Pardot::NetError => e
# the API request failed
# - socket broke before the request was completed
# - pi.pardot.com is under heavy load
# - many number of other reasons
- end
\ No newline at end of file
+ end
+
+=== License
+The MIT License (MIT)
+Copyright (c) 2012 Pardot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.