Adding advanced search. Fixes issue #216.

Author: kevbite

src/CompaniesHouse.Extensions.Microsoft.DependencyInjection/CompaniesHouseClientServiceCollectionExtensions.cs

@@ -19,12 +19,9 @@ public static class CompaniesHouseClientServiceCollectionExtensions
         /// <returns>Service collection</returns>
         public static IServiceCollection AddCompaniesHouseClient(this IServiceCollection services, string apiKey)
         {
-            return services.AddCompaniesHouseClient(opt =>
-            {
-                opt.ApiKey = apiKey;
-            });
+            return services.AddCompaniesHouseClient(opt => { opt.ApiKey = apiKey; });
         }
-        
+
         /// <summary>
         /// Registers the companies house client
         /// </summary>
@@ -69,7 +66,7 @@ public static IServiceCollection AddCompaniesHouseClient(this IServiceCollection
                 configure.Invoke(provider, options);
                 return options;
             });
-            
+
             services.TryAddTransient<IApiKeyProvider>(provider =>
             {
                 var options = provider.GetRequiredService<CompaniesHouseClientOptions>();
@@ -89,6 +86,8 @@ public static IServiceCollection AddCompaniesHouseClient(this IServiceCollection
 
             services.TryAddTransient<ICompaniesHouseSearchCompanyClient>(provider =>
                 provider.GetService<ICompaniesHouseClient>());
+            services.TryAddTransient<ICompaniesHouseSearchCompanyAdvancedClient>(provider =>
+                provider.GetService<ICompaniesHouseClient>());
             services.TryAddTransient<ICompaniesHouseSearchOfficerClient>(provider =>
                 provider.GetService<ICompaniesHouseClient>());
             services.TryAddTransient<ICompaniesHouseSearchDisqualifiedOfficerClient>(provider =>
@@ -103,8 +102,8 @@ public static IServiceCollection AddCompaniesHouseClient(this IServiceCollection
                 provider.GetService<ICompaniesHouseClient>());
             services.TryAddTransient<ICompaniesHouseCompanyInsolvencyInformationClient>(provider =>
                 provider.GetService<ICompaniesHouseClient>());
-            services.TryAddTransient<ICompaniesHouseAppointmentsClient>(
-                provider => provider.GetService<ICompaniesHouseClient>());
+            services.TryAddTransient<ICompaniesHouseAppointmentsClient>(provider =>
+                provider.GetService<ICompaniesHouseClient>());
             services.TryAddTransient<ICompaniesHousePersonsWithSignificantControlClient>(provider =>
                 provider.GetService<ICompaniesHouseClient>());
             services.TryAddTransient<ICompaniesHouseChargesClient>(provider =>

src/CompaniesHouse/CompaniesHouseClient.cs

@@ -1,7 +1,4 @@
-using System;
-using System.Net.Http;
-using System.Threading;
-using System.Threading.Tasks;
+using System.Net.Http;
 using CompaniesHouse.Request;
 using CompaniesHouse.Response.Appointments;
 using CompaniesHouse.Response.Charges;
@@ -58,6 +55,11 @@ public CompaniesHouseClient(ICompaniesHouseSettings settings)
         {
             return _companiesHouseSearchClient.SearchAsync<SearchCompanyRequest, CompanySearch>(request, cancellationToken);
         }
+        
+        public Task<CompaniesHouseClientResponse<CompanySearch>> SearchCompanyAdvancedAsync(AdvancedSearchCompanyRequest request, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            return _companiesHouseSearchClient.SearchAsync<AdvancedSearchCompanyRequest, CompanySearch>(request, cancellationToken);
+        }
 
         public Task<CompaniesHouseClientResponse<OfficerSearch>> SearchOfficerAsync(SearchOfficerRequest request, CancellationToken cancellationToken = default(CancellationToken))
         {

src/CompaniesHouse/HttpContentExtensions.cs

@@ -2,20 +2,25 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace CompaniesHouse
 {
     public static class HttpContentExtensions
     {
+        public static readonly JsonSerializer Serializer = new()
+        {
+            Converters = { new StringEnumConverter() }
+        };
+
         public static async Task<T> ReadAsJsonAsync<T>(this HttpContent content)
         {
             using var s = await content.ReadAsStreamAsync()
                 .ConfigureAwait(false);
             using var sr = new StreamReader(s);
             using var reader = new JsonTextReader(sr);
-            var serializer = new JsonSerializer();
 
-            return serializer.Deserialize<T>(reader);
+            return Serializer.Deserialize<T>(reader);
         }
     }
 }

src/CompaniesHouse/ICompaniesHouseClient.cs

@@ -2,6 +2,7 @@
 {
     public interface ICompaniesHouseClient :
         ICompaniesHouseSearchCompanyClient,
+        ICompaniesHouseSearchCompanyAdvancedClient,
         ICompaniesHouseSearchOfficerClient,
         ICompaniesHouseSearchDisqualifiedOfficerClient,
         ICompaniesHouseSearchAllClient,

src/CompaniesHouse/ICompaniesHouseSearchCompanyAdvancedClient.cs

@@ -0,0 +1,10 @@
+using CompaniesHouse.Request;
+using CompaniesHouse.Response.Search.CompanySearch;
+
+namespace CompaniesHouse;
+
+public interface ICompaniesHouseSearchCompanyAdvancedClient
+{
+    Task<CompaniesHouseClientResponse<CompanySearch>> SearchCompanyAdvancedAsync(
+        AdvancedSearchCompanyRequest request, CancellationToken cancellationToken = default(CancellationToken));
+}

src/CompaniesHouse/Request/AdvancedSearchCompanyRequest.cs

@@ -0,0 +1,20 @@
+#nullable enable
+using CompaniesHouse.Response;
+using CompaniesHouse.Response.Search.CompanySearch;
+
+namespace CompaniesHouse.Request;
+
+public class AdvancedSearchCompanyRequest : SearchRequest<CompanySearch>
+{
+    public string? CompanyNameIncludes { get; set; }
+    public string? CompanyNameExcludes { get; set; }
+    public IReadOnlyCollection<CompanyStatus> CompanyStatus { get; set; } = [];
+    public IReadOnlyCollection<CompanySubType> CompanySubtype { get; set; } = [];
+    public IReadOnlyCollection<CompanyType> CompanyType { get; set; } = [];
+    public DateTime? DissolvedFrom { get; set; }
+    public DateTime? DissolvedTo { get; set; }
+    public DateTime? IncorporatedFrom { get; set; }
+    public DateTime? IncorporatedTo { get; set; }
+    public string? Location { get; set; }
+    public IReadOnlyCollection<string> SicCodes { get; set; } = [];
+}

src/CompaniesHouse/Request/IQuerySearchRequest.cs

@@ -0,0 +1,6 @@
+namespace CompaniesHouse.Request;
+
+public interface IQuerySearchRequest : ISearchRequest
+{
+    string Query { get; }
+}

src/CompaniesHouse/Request/ISearchRequest.cs

@@ -2,8 +2,6 @@
 
 public interface ISearchRequest
 {
-    string Query { get; }
-
     int? ItemsPerPage { get; }
 
     int? StartIndex { get; }

src/CompaniesHouse/Request/SearchAllRequest.cs

@@ -2,6 +2,6 @@
 
 namespace CompaniesHouse.Request;
 
-public class SearchAllRequest : SearchRequest<AllSearch>
+public class SearchAllRequest : QuerySearchRequest<AllSearch>
 {
 }

src/CompaniesHouse/Request/SearchCompanyRequest.cs

@@ -1,8 +1,9 @@
-using CompaniesHouse.Response.Search.CompanySearch;
+#nullable enable
+using CompaniesHouse.Response.Search.CompanySearch;
 
 namespace CompaniesHouse.Request;
 
-public class SearchCompanyRequest : SearchRequest<CompanySearch>
+public class SearchCompanyRequest : QuerySearchRequest<CompanySearch>
 {
-    public string Restrictions { get; set; }
+    public string? Restrictions { get; set; }
 }