Updating usage docs and examples based on testing against deployed Nuget

thinkingserious · thinkingserious · commit 6432c3c93b1d · 2016-06-15T14:23:48.000-07:00
diff --git a/README.md b/README.md
@@ -46,6 +46,7 @@ Add the following namespaces to use the library:
 using System;
 using System.Web.Script.Serialization;
 using SendGrid;
+using SendGrid.Helpers.Mail; // Include if you want to use the Mail Helper
 ```
 
 ## Dependencies
@@ -60,6 +61,7 @@ using SendGrid;
 ```csharp
 using System;
 using SendGrid;
+using SendGrid.Helpers.Mail;
 
 namespace Example
 {
@@ -68,7 +70,7 @@ namespace Example
         private static void Main()
         {
 	    String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
-            dynamic sg = new SendGrid.SendGridAPIClient(apiKey);
+            dynamic sg = new SendGridAPIClient(apiKey);
 
             Email from = new Email("test@example.com");
             String subject = "Hello World from the SendGrid CSharp Library";
@@ -86,7 +88,6 @@ namespace Example
 
 ```csharp
 using System;
-using SendGrid;
 
 namespace Example
 {
@@ -96,7 +97,7 @@ namespace Example
         {
             String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
             dynamic sg = new SendGrid.SendGridAPIClient(apiKey);
-            dynamic response = sg.client.api_keys.get(queryParams: queryParams);
+            dynamic response = sg.client.api_keys.get();
         }
     }
 }
diff --git a/USAGE.md b/USAGE.md
@@ -4,8 +4,7 @@ This documentation is based on our [OAI specification](https://github.com/sendgr
 
 ```csharp
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/accesssettings/accesssettings.cs b/examples/accesssettings/accesssettings.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/apikeys/apikeys.cs b/examples/apikeys/apikeys.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/asm/asm.cs b/examples/asm/asm.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/browsers/browsers.cs b/examples/browsers/browsers.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/campaigns/campaigns.cs b/examples/campaigns/campaigns.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/categories/categories.cs b/examples/categories/categories.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/clients/clients.cs b/examples/clients/clients.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/contactdb/contactdb.cs b/examples/contactdb/contactdb.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/devices/devices.cs b/examples/devices/devices.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/geo/geo.cs b/examples/geo/geo.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/ips/ips.cs b/examples/ips/ips.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/mail/mail.cs b/examples/mail/mail.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
@@ -29,7 +28,7 @@
 ////////////////////////////////////////////////////////
 // v3 Mail Send
 // POST /mail/send
-# This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/SendGrid/SendGrid/Helpers/Mail/README.md).
+// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/SendGrid/SendGrid/Helpers/Mail/README.md).
 
 string data = @"{
   'asm': {
diff --git a/examples/mailboxproviders/mailboxproviders.cs b/examples/mailboxproviders/mailboxproviders.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/mailsettings/mailsettings.cs b/examples/mailsettings/mailsettings.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/partnersettings/partnersettings.cs b/examples/partnersettings/partnersettings.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/scopes/scopes.cs b/examples/scopes/scopes.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/stats/stats.cs b/examples/stats/stats.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/subusers/subusers.cs b/examples/subusers/subusers.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/suppression/suppression.cs b/examples/suppression/suppression.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/templates/templates.cs b/examples/templates/templates.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/trackingsettings/trackingsettings.cs b/examples/trackingsettings/trackingsettings.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
diff --git a/examples/user/user.cs b/examples/user/user.cs
@@ -1,6 +1,5 @@
 using System;
-using SendGrid.Helpers.Mail;
-using System.Collections.Generic;
+using SendGrid.Helpers.Mail; // If you are using the Mail Helper
 
 string _apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
 dynamic sg = new SendGrid.SendGridAPIClient(_apiKey);
@@ -53,7 +52,7 @@
 // PUT /user/password
 
 string data = @"{
-  'new_password': 'new_password', 
+  'new_password': 'new_password',
   'old_password': 'old_password'
 }";
 dynamic response = sg.client.user.password.put(requestBody: data);
@@ -67,8 +66,8 @@
 // PATCH /user/profile
 
 string data = @"{
-  'city': 'Orange', 
-  'first_name': 'Example', 
+  'city': 'Orange',
+  'first_name': 'Example',
   'last_name': 'User'
 }";
 dynamic response = sg.client.user.profile.patch(requestBody: data);
@@ -92,7 +91,7 @@
 // POST /user/scheduled_sends
 
 string data = @"{
-  'batch_id': 'YOUR_BATCH_ID', 
+  'batch_id': 'YOUR_BATCH_ID',
   'status': 'pause'
 }";
 dynamic response = sg.client.user.scheduled_sends.post(requestBody: data);
@@ -152,7 +151,7 @@
 // PATCH /user/settings/enforced_tls
 
 string data = @"{
-  'require_tls': true, 
+  'require_tls': true,
   'require_valid_cert': false
 }";
 dynamic response = sg.client.user.settings.enforced_tls.patch(requestBody: data);
@@ -199,18 +198,18 @@
 // PATCH /user/webhooks/event/settings
 
 string data = @"{
-  'bounce': true, 
-  'click': true, 
-  'deferred': true, 
-  'delivered': true, 
-  'dropped': true, 
-  'enabled': true, 
-  'group_resubscribe': true, 
-  'group_unsubscribe': true, 
-  'open': true, 
-  'processed': true, 
-  'spam_report': true, 
-  'unsubscribe': true, 
+  'bounce': true,
+  'click': true,
+  'deferred': true,
+  'delivered': true,
+  'dropped': true,
+  'enabled': true,
+  'group_resubscribe': true,
+  'group_unsubscribe': true,
+  'open': true,
+  'processed': true,
+  'spam_report': true,
+  'unsubscribe': true,
   'url': 'url'
 }";
 dynamic response = sg.client.user.webhooks._("event").settings.patch(requestBody: data);
@@ -230,7 +229,7 @@
 Console.ReadLine();
 
 ////////////////////////////////////////////////////////
-// Test Event Notification Settings 
+// Test Event Notification Settings
 // POST /user/webhooks/event/test
 
 string data = @"{
@@ -257,10 +256,10 @@
 // GET /user/webhooks/parse/stats
 
 string queryParams = @"{
-  'aggregated_by': 'day', 
-  'end_date': '2016-04-01', 
-  'limit': 'test_string', 
-  'offset': 'test_string', 
+  'aggregated_by': 'day',
+  'end_date': '2016-04-01',
+  'limit': 'test_string',
+  'offset': 'test_string',
   'start_date': '2016-01-01'
 }";
 dynamic response = sg.client.user.webhooks.parse.stats.get(queryParams: queryParams);
diff --git a/examples/whitelabel/whitelabel.cs b/examples/whitelabel/whitelabel.cs

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ Add the following namespaces to use the library:`
`46`	`46`	`using System;`
`47`	`47`	`using System.Web.Script.Serialization;`
`48`	`48`	`using SendGrid;`
	`49`	`+using SendGrid.Helpers.Mail; // Include if you want to use the Mail Helper`
`49`	`50`	```
`50`	`51`
`51`	`52`	`## Dependencies`
`@@ -60,6 +61,7 @@ using SendGrid;`
`60`	`61`	```csharp
`61`	`62`	`using System;`
`62`	`63`	`using SendGrid;`
	`64`	`+using SendGrid.Helpers.Mail;`
`63`	`65`
`64`	`66`	`namespace Example`
`65`	`67`	`{`
`@@ -68,7 +70,7 @@ namespace Example`
`68`	`70`	`private static void Main()`
`69`	`71`	`{`
`70`	`72`	`String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);`
`71`		`- dynamic sg = new SendGrid.SendGridAPIClient(apiKey);`
	`73`	`+ dynamic sg = new SendGridAPIClient(apiKey);`
`72`	`74`
`73`	`75`	`Email from = new Email("[email protected]");`
`74`	`76`	`String subject = "Hello World from the SendGrid CSharp Library";`
`@@ -86,7 +88,6 @@ namespace Example`
`86`	`88`
`87`	`89`	```csharp
`88`	`90`	`using System;`
`89`		`-using SendGrid;`
`90`	`91`
`91`	`92`	`namespace Example`
`92`	`93`	`{`
`@@ -96,7 +97,7 @@ namespace Example`
`96`	`97`	`{`
`97`	`98`	`String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);`
`98`	`99`	`dynamic sg = new SendGrid.SendGridAPIClient(apiKey);`
`99`		`- dynamic response = sg.client.api_keys.get(queryParams: queryParams);`
	`100`	`+ dynamic response = sg.client.api_keys.get();`
`100`	`101`	`}`
`101`	`102`	`}`
`102`	`103`	`}`