README.rdoc in sendgrid_webapi-0.0.8 vs README.rdoc in sendgrid_webapi-0.1.0
- old
+ new
@@ -17,11 +17,11 @@
== Usage examples
=== Creating client object:
- client = SendGridWebApi::Client.new("user_name", "password")
+ client = SendGridWebApi::Client.new("apikey")
== Modules
=== Bounces
This module allows you to retrieve and delete email addresses that have bounced from emails that you've delivered.
@@ -129,11 +129,11 @@
== SubUser
=== Creating client object:
- client = SendGridWebApi::Client.new("user_name", "password")
+ client = SendGridWebApi::Client.new("apikey")
client.sub_user
== Modules
@@ -337,9 +337,34 @@
client.sub_user.apps.customize(:user => "sub_user", :name => "eventnotify", :processed => "0", :dropped => "1", :deferred => "1", :delivered => "0", :bounce => "1", :click => "1", :open => "1", :unsubscribe => "1", :spamreport => "1", :url => "http://someurl.com/listener"))
* options are available here: http://sendgrid.com/docs/API_Reference/Customer_Subuser_API/apps.html
+
+=== Apikey
+This module allows you to manage apikeys
+
+ client.apikey.management.get
+
+ client.apikey.management.get({ on_behalf_of: "SUB_USERNAME" })
+
+ client.apikey.management.get({ apikey_id: "APIKEY_ID" })
+
+ client.apikey.management.get({ on_behalf_of: "SUB_USERNAME" })
+
+ client.apikey.management.create({ "name" => "APIKEY NAME", "scopes" => ["mail.send"] })
+
+ client.apikey.management.create({ on_behalf_of: "SUB_USERNAME", "name" => "APIKEY NAME", "scopes" => ["mail.send"] })
+
+ client.apikey.management.update("APIKEY_ID", { "name" => "NEW APIKEY NAME"})
+
+ client.apikey.management.update("APIKEY_ID", { on_behalf_of: "SUB_USERNAME", "name" => "NEW APIKEY NAME"})
+
+ client.apikey.management.delete("APIKEY_ID")
+
+ client.apikey.management.delete("APIKEY_ID", { on_behalf_of: "SUB_USERNAME" })
+
+* options are available here: https://sendgrid.com/docs/api-reference/
== Helper
=== Create Sub User
this helper allows you to create a sub_user and enable apps that you want, passing a array with the sub_user data