Merge branch 'master' into SingleHubAPIKey

Author: clarkd

HubSpot.NET.Examples/Contacts.cs

@@ -12,6 +12,14 @@ public class Contacts
     {
         public static void Example(HubSpotApi api)
         {
+            /**
+             * Search for a contact
+             */
+            var found = api.Contact.Search<ContactHubSpotModel>(new ContactSearchRequestOptions()
+            {
+                Query = ".com"
+            });
+
             /**
              * Create a contact
              */
@@ -95,6 +103,8 @@ public static void Example(HubSpotApi api)
             {
                 Limit = 10
             });
+
+          
         }
     }
 }

HubSpot.NET/Api/Contact/Dto/ContactSearchHubSpotModel.cs

@@ -0,0 +1,79 @@
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+using HubSpot.NET.Core.Interfaces;
+
+namespace HubSpot.NET.Api.Contact.Dto
+{
+    public class ContactSearchHubSpotModel<T> : IHubSpotModel where T : ContactHubSpotModel, new()
+    {
+
+        /// <summary>
+        /// Gets or sets the query term used to get the results.
+        /// </summary>
+        /// <value>
+        /// The query term.
+        /// </value>
+        /// <remarks>
+        /// This is a mapping of the "query" prop in the JSON return data from HubSpot
+        /// </remarks>
+        [DataMember(Name = "query")]
+        public string Query { get; set; }
+
+        /// <summary>
+        /// Gets or sets the contacts.
+        /// </summary>
+        /// <value>
+        /// The contacts.
+        /// </value>
+        [DataMember(Name = "contacts")]
+        public IList<T> Contacts { get; set; } = new List<T>();
+
+        /// <summary>
+        /// Gets or sets a value indicating whether more results are available.
+        /// </summary>
+        /// <value>
+        /// <c>true</c> if [more results available]; otherwise, <c>false</c>.
+        /// </value>
+        /// <remarks>
+        /// This is a mapping of the "has-more" prop in the JSON return data from HubSpot
+        /// </remarks>
+        [DataMember(Name = "has-more")]
+        public bool MoreResultsAvailable { get; set; }
+
+        /// <summary>
+        /// Gets or sets the continuation offset.
+        /// </summary>
+        /// <value>
+        /// The continuation offset.
+        /// </value>
+        /// <remarks>
+        /// This is a mapping of the "offset" prop in the JSON reeturn data from HubSpot
+        /// </remarks>
+        [DataMember(Name = "offset")]
+        public long ContinuationOffset { get; set; }
+
+        /// <summary>
+        /// Gets or sets the total.
+        /// </summary>
+        /// <value>
+        /// The total number of contacts found.
+        /// </value>
+        /// <remarks>
+        /// This is a mapping of the "total" prop in the JSON return data from HubSpot
+        /// </remarks>
+        [DataMember(Name = "total")]
+        public long Total { get; set; }
+
+        public string RouteBasePath => "/contacts/v1";
+
+        public bool IsNameValue => false;
+
+        public virtual void ToHubSpotDataEntity(ref dynamic converted)
+        {
+        }
+
+        public virtual void FromHubSpotDataEntity(dynamic hubspotData)
+        {
+        }
+    }
+}

HubSpot.NET/Api/Contact/Dto/ContactSearchRequestOptions.cs

@@ -0,0 +1,16 @@
+using HubSpot.NET.Core;
+
+namespace HubSpot.NET.Api.Contact.Dto
+{
+    /// <summary>
+    /// Options used when querying for a list matching the query term
+    /// </summary>
+    public class ContactSearchRequestOptions : ListRequestOptions
+    {   
+        /// <summary>
+        /// Gets or set the query term to use when searching
+        /// </summary>
+        public string Query { get; set; }
+
+    }
+}

HubSpot.NET/Api/Contact/HubSpotContactApi.cs

@@ -197,6 +197,32 @@ public void Delete(long contactId)
             return data;
         }
 
+        public ContactSearchHubSpotModel<T> Search<T>(ContactSearchRequestOptions opts = null) where T : ContactHubSpotModel, new()
+        {
+            if (opts == null)
+            {
+                opts = new ContactSearchRequestOptions();
+            }
+
+            var path = $"{new T().RouteBasePath}/search/query"
+                .SetQueryParam("q", opts.Query)
+                .SetQueryParam("count", opts.Limit);
+
+            if (opts.PropertiesToInclude.Any())
+            {
+                path.SetQueryParam("property", opts.PropertiesToInclude);
+            }
+
+            if (opts.Offset.HasValue)
+            {
+                path = path.SetQueryParam("offset", opts.Offset);
+            }
+
+            var data = _client.ExecuteList<ContactSearchHubSpotModel<T>>(path, opts);
+
+            return data;
+        }
+
         /// <summary>
         /// Get a list of recently created contacts
         /// </summary>

HubSpot.NET/Core/Interfaces/IHubSpotContactApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using HubSpot.NET.Api.Company;
 using HubSpot.NET.Api.Contact;
 using HubSpot.NET.Api.Contact.Dto;
 
@@ -17,5 +18,6 @@ public interface IHubSpotContactApi
         void Update<T>(T contact) where T : ContactHubSpotModel, new();
         ContactListHubSpotModel<T> RecentlyCreated<T>(ListRecentRequestOptions opts = null) where T : ContactHubSpotModel, new();
         ContactListHubSpotModel<T> RecentlyUpdated<T>(ListRecentRequestOptions opts = null) where T : ContactHubSpotModel, new();
+        ContactSearchHubSpotModel<T> Search<T>(ContactSearchRequestOptions opts = null) where T : ContactHubSpotModel, new();
     }
 }