Merge pull request #48 from smartystreets/eric/add-custom-parameter

Eric/add custom parameter

Author: RyanLCox1

src/examples/InternationalAutocompleteExample.cs

@@ -36,6 +36,9 @@ public static void Run()
 				Locality = "Paris",
 			};
 
+			//uncomment the line below to add a custom parameter
+			//lookup.AddCustomParameter("max_results", "3");
+
             try
             {
                 client.Send(lookup);

src/examples/InternationalStreetExample.cs

@@ -41,6 +41,9 @@ public static void Run()
 				Country = "Brazil",
 				PostalCode = "02516-050"
 			};
+			
+			//uncomment the line below to add a custom parameter
+			//lookup.AddCustomParameter("input_id", "ID-8675309");
 
             try
             {

src/examples/USAutocompleteProExample.cs

@@ -78,6 +78,9 @@ public static void Run()
 			lookup.PreferRatio = 4;
 			lookup.Source = "all";
 
+			//uncomment the below line to add a custom parameter
+			//lookup.AddCustomParameter("source", "all");
+
             try
             {
                 client.Send(lookup);

src/examples/USEnrichmentGeoReferenceExample.cs

@@ -39,6 +39,9 @@ public static void Run()
             componentsLookup.SetState("NJ");
             componentsLookup.SetZipcode("08876");
 
+            //uncomment the below line to add a custom parameter
+            //componentsLookup.AddCustomParameter("zipcode", "08876");
+
             // Create a lookup with a single line address using the line below
             var freeformLookup = new SmartyStreets.USEnrichmentApi.GeoReference.Lookup();
             freeformLookup.SetFreeform("56 Union Ave Somerville NJ 08876");

src/examples/USEnrichmentPropertyExample.cs

@@ -39,6 +39,9 @@ public static void Run()
             componentsLookup.SetState("NJ");
             componentsLookup.SetZipcode("08876");
 
+            //uncomment the below line to add a custom parameter
+            //componentsLookup.AddCustomParameter("zipcode", "08876");
+
             // Create a lookup with a single line address using the line below
             var freeformLookup = new SmartyStreets.USEnrichmentApi.Property.Principal.Lookup();
             freeformLookup.SetFreeform("56 Union Ave Somerville NJ 08876");
@@ -83,6 +86,9 @@ public static void Run()
             financialComponentsLookup.SetState("NJ");
             financialComponentsLookup.SetZipcode("08876");
 
+            //uncomment the below line to add a custom parameter
+            //financialComponentsLookup.AddCustomParameter("zipcode", "08876");
+
             // Create a lookup with a single line address using the line below
             var financialFreeformLookup = new SmartyStreets.USEnrichmentApi.Property.Financial.Lookup();
             financialFreeformLookup.SetFreeform("56 Union Ave Somerville NJ 08876");

src/examples/USEnrichmentSecondaryExample.cs

@@ -40,6 +40,9 @@ public static void Run()
             componentsLookup.SetState("NJ");
             componentsLookup.SetZipcode("08876");
 
+            //uncomment the below line to add a custom parameter
+            //componentsLookup.AddCustomParameter("zipcode", "08876");
+
             // Create a lookup with a single line address using the line below
             var freeformLookup = new SmartyStreets.USEnrichmentApi.Secondary.Lookup();
             freeformLookup.SetFreeform("56 Union Ave Somerville NJ 08876");
@@ -95,6 +98,9 @@ public static void Run()
             countComponentsLookup.SetState("NJ");
             countComponentsLookup.SetZipcode("08876");
 
+            //uncomment the below line to add a custom parameter
+            //countComponentsLookup.AddCustomParameter("zipcode", "08876");
+
             // Create a lookup with a single line address using the line below
             var countFreeformLookup = new SmartyStreets.USEnrichmentApi.Secondary.Count.Lookup();
             countFreeformLookup.SetFreeform("56 Union Ave Somerville NJ 08876");

src/examples/USEnrichmentUniversalExample.cs

@@ -42,6 +42,9 @@ public static void Run()
             componentsLookup.SetState("NJ");
             componentsLookup.SetZipcode("08876");
 
+            //uncomment the line below to add a custom parameter
+            //componentsLookup.AddCustomParameter("zipcode", "08876");
+
             // Create a lookup with a single line address using the lines below
             var freeformLookup = new SmartyStreets.USEnrichmentApi.Universal.Lookup();
             freeformLookup.SetDatasetName("property");

src/examples/USExtractExample.cs

@@ -32,6 +32,9 @@ public static void Run()
 				AddressesHaveLineBreaks = false,
 				AddressesPerLine = 1
 			};
+
+			//uncomment the line below to add a custom parameter
+			//lookup.AddCustomParameter("addr_line_breaks", "false");
 
             try
             {

src/examples/USReverseGeoExample.cs

@@ -35,6 +35,9 @@ public static void Run()
 
 			var lookup = new Lookup(40.111111, -111.111111);
 
+			//uncomment the line below to add a custom parameter
+			//lookup.AddCustomParameter("source", "all");
+
 			try
 			{
 				client.Send(lookup);

src/examples/USStreetLookupsWithMatchStrategyExamples.cs

@@ -37,6 +37,9 @@ public static void Run()
 				MatchStrategy = Lookup.STRICT
 			};
 
+			//uncomment the line below to add a custom parameter
+			//addressWithStrictStrategy.AddCustomParameter("city", "provo");
+
 			var addressWithEnhancedStrategy = new Lookup
 			{
 				Street = "693 W 1150 S",

src/examples/USStreetMultipleAddressesExample.cs

@@ -46,6 +46,9 @@ public static void Run()
                                                // Refer to the documentation for additional MatchStrategy options.
 			};
 
+			//uncomment the line below to add a custom parameter
+			//address1.AddCustomParameter("InputId", "24601");
+
 			var address2 = new Lookup("1 Rosedale, Baltimore, Maryland")
 			{
 				Street = "1 Rosedale",

src/examples/USStreetSingleAddressEndpointExample.cs

@@ -51,6 +51,9 @@ public static void Run()
                                                // Refer to the documentation for additional MatchStrategy options.
 			};
 
+			//uncomment the line below to add a custom parameter
+			//lookup.AddCustomParameter("InputId", "24601");
+
 			try
 			{
 				client.Send(lookup);

src/examples/USStreetSingleAddressExample.cs

@@ -44,12 +44,16 @@ public static void Run()
 				City = "Mountain View",
 				State = "CA",
 				ZipCode = "21229",
+				CountySource = Lookup.GEOGRAPHIC,
 				MaxCandidates = 3,
 				MatchStrategy = Lookup.ENHANCED // "invalid" is the most permissive match,
                                                // this will always return at least one result even if the address is invalid.
                                                // Refer to the documentation for additional MatchStrategy options.
 			};
 
+			//uncomment the line below to add a custom parameter
+			//lookup.AddCustomParameter("county_source", "geographic");
+
 			try
 			{
 				client.Send(lookup);

src/examples/USZipCodeMultipleLookupsExample.cs

@@ -26,6 +26,10 @@ public static void Run()
 				ZipCode = "12345"
 			};
 
+			//uncomment the lines below to add custom parameters
+			// lookup1.AddCustomParameter("city", "Schenectady");
+			// lookup1.AddCustomParameter("state", "NY");
+
 			var lookup2 = new Lookup
 			{
 				City = "Phoenix",

src/examples/USZipCodeSingleLookupExample.cs

@@ -31,6 +31,9 @@ public static void Run()
 				ZipCode = "94039"
 			};
 
+			//uncomment the line below to add a custom parameter
+			//lookup.AddCustomParameter("zipcode", "94039");
+
 			try
 			{
 				client.Send(lookup);

src/sdk/InternationalAutcompleteApi/Client.cs

@@ -3,6 +3,7 @@
 	using System;
 	using System.Collections;
 	using System.IO;
+	using System.Collections.Generic;
 
 	/// <summary>
 	///     This client sends lookups to the SmartyStreets US Autocomplete API,
@@ -58,6 +59,10 @@ private static Request BuildRequest(Lookup lookup)
 			request.SetParameter("max_results", lookup.MaxSuggestionsString);
 			request.SetParameter("include_only_locality", lookup.Locality);
 			request.SetParameter("include_only_postal_code", lookup.PostalCode);
+
+			foreach (KeyValuePair<string, string> line in lookup.CustomParamDict) {
+				request.SetParameter(line.Key, line.Value);
+			}
 
 			return request;
 		}

src/sdk/InternationalAutcompleteApi/Lookup.cs

@@ -1,6 +1,7 @@
 namespace SmartyStreets.InternationalAutocompleteApi
 {
 	using System.Collections;
+	using System.Collections.Generic;
 
 	/// <summary>
 	///     In addition to holding all of the input data for this lookup, this class also
@@ -22,6 +23,7 @@ public class Lookup
 		public int MaxResults { get; set; }
 		public string Locality { get; set; }
 		public string PostalCode { get; set; }
+		public Dictionary<string, string> CustomParamDict = new Dictionary<string, string>{};
 
 		#endregion
 
@@ -46,5 +48,8 @@ public Lookup(string search) : this()
 
 		internal string MaxSuggestionsString => this.MaxResults.ToString();
 
+		public void AddCustomParameter(string parameter, string value) {
+			CustomParamDict.Add(parameter, value);
+		}
 	}
 }

src/sdk/InternationalStreetApi/Client.cs

@@ -57,6 +57,10 @@ private static Request BuildRequest(Lookup lookup)
 			request.SetParameter("administrative_area", lookup.AdministrativeArea);
 			request.SetParameter("postal_code", lookup.PostalCode);
 
+			foreach (KeyValuePair<string, string> line in lookup.CustomParamDict) {
+				request.SetParameter(line.Key, line.Value);
+			}
+
 			return request;
 		}
 

src/sdk/InternationalStreetApi/Lookup.cs

@@ -42,6 +42,7 @@ public class Lookup : ILookup
 		public string Locality { get; set; }
 		public string AdministrativeArea { get; set; }
 		public string PostalCode { get; set; }
+		public Dictionary<string, string> CustomParamDict = new Dictionary<string, string>{};
 
 		#endregion
 
@@ -118,5 +119,9 @@ public void AddToResult(Candidate newCandidate)
 		{
 			this.Result.Add(newCandidate);
 		}
+
+		public void AddCustomParameter(string parameter, string value) {
+			CustomParamDict.Add(parameter, value);
+		}
 	}
 }

src/sdk/USAutocompleteProApi/Client.cs

@@ -3,6 +3,7 @@
 	using System;
 	using System.Collections;
 	using System.IO;
+	using System.Collections.Generic;
 
 	/// <summary>
 	///     This client sends lookups to the SmartyStreets US Autocomplete API,
@@ -57,6 +58,10 @@ private static Request BuildRequest(Lookup lookup)
 			request.SetParameter("selected", lookup.Selected);
 			request.SetParameter("source", lookup.Source);
 
+			foreach (KeyValuePair<string, string> line in lookup.CustomParamDict) {
+				request.SetParameter(line.Key, line.Value);
+			}
+
 			return request;
 		}
 

src/sdk/USAutocompleteProApi/Lookup.cs

@@ -3,6 +3,7 @@
 namespace SmartyStreets.USAutocompleteProApi
 {
 	using System.Collections;
+	using System.Collections.Generic;
 
 	/// <summary>
 	///     In addition to holding all of the input data for this lookup, this class also
@@ -31,6 +32,7 @@ public class Lookup
 		public string PreferGeolocation { get; set; }
 		public string Selected { get; set; }
 		public string Source { get; set; }
+		public Dictionary<string, string> CustomParamDict = new Dictionary<string, string>{};
 
 		#endregion
 
@@ -112,5 +114,9 @@ public void AddPreferZIP(string zipcode)
 			this.PreferGeolocation = GeolocateType.NONE;
 			this.PreferZIPCodes.Add(zipcode);
 		}
+
+		public void AddCustomParameter(string parameter, string value) {
+			CustomParamDict.Add(parameter, value);
+		}
 	}
 }

src/sdk/USEnrichmentApi/Client.cs

@@ -2,6 +2,7 @@ namespace SmartyStreets.USEnrichmentApi
 {
     using System;
 	using System.IO;
+	using System.Collections.Generic;
 
     public class Client //: IUSEnrichmentClient
     {
@@ -150,6 +151,10 @@ private SmartyStreets.Request BuildRequest(Lookup lookup)
 				request.SetHeader("Etag", lookup.GetEtag());
 			}
 
+			foreach (KeyValuePair<string, string> line in lookup.CustomParamDict) {
+				request.SetParameter(line.Key, line.Value);
+			}
+
 			return request;
 		}
     }

src/sdk/USEnrichmentApi/Lookup.cs

@@ -1,3 +1,5 @@
+using System.Collections.Generic;
+
 namespace SmartyStreets.USEnrichmentApi
 {
     using System;
@@ -15,6 +17,7 @@ public abstract class Lookup
         private string zipcode;
         private string includeFields;
         private string excludeFields;
+        public Dictionary<string, string> CustomParamDict = new Dictionary<string, string>{};
         private string eTag;
 
         public Lookup(string smartyKey = null, string datasetName = null, string dataSubsetName = null, string freeform = null, string street = null,
@@ -141,6 +144,10 @@ public void SetZipcode(string zipcode)
         }
 
         public abstract void DeserializeAndSetResults(SmartyStreets.ISerializer serializer, Stream payload);
+
+        public void AddCustomParameter(string parameter, string value) {
+			CustomParamDict.Add(parameter, value);
+		}
     }
 
 }

src/sdk/USExtractApi/Client.cs

@@ -1,4 +1,6 @@
-namespace SmartyStreets.USExtractApi
+using System.Collections.Generic;
+
+namespace SmartyStreets.USExtractApi
 {
 	using System;
 	using System.IO;
@@ -52,6 +54,10 @@ private static Request BuildRequest(Lookup lookup)
 			if ((lookup.MatchStrategy != "") && (lookup.MatchStrategy != Lookup.STRICT))
 				request.SetParameter("match", lookup.MatchStrategy);
 
+			foreach (KeyValuePair<string, string> line in lookup.CustomParamDict) {
+				request.SetParameter(line.Key, line.Value);
+			}
+
 			return request;
 		}
 	}

src/sdk/USExtractApi/Lookup.cs

@@ -1,4 +1,7 @@
-namespace SmartyStreets.USExtractApi
+using System.Collections.Generic;
+
+namespace SmartyStreets.USExtractApi
+
 {
 	/// <summary>
 	///     In addition to holding all of the input data for this lookup, this class also
@@ -20,6 +23,7 @@ public class Lookup
 		public int AddressesPerLine { get; set; }
 		public string MatchStrategy { get; set; }
 		public string Text { get; set; }
+		public Dictionary<string, string> CustomParamDict = new Dictionary<string, string>{};
 
 		#endregion
 
@@ -51,5 +55,9 @@ public void SpecifyHtmlInput(bool html)
 		{
 			this.html = html.ToString().ToLower();
 		}
+
+		public void AddCustomParameter(string parameter, string value) {
+			CustomParamDict.Add(parameter, value);
+		}
 	}
 }