Add advanced company search models and update related request handling

Author: kevbite

src/CompaniesHouse/CompaniesHouseClient.cs

@@ -8,11 +8,12 @@
 using CompaniesHouse.Response.Officers;
 using CompaniesHouse.Response.PersonsWithSignificantControl;
 using CompaniesHouse.Response.RegisteredOfficeAddress;
+using CompaniesHouse.Response.Search.AdvancedCompanySearch;
 using CompaniesHouse.Response.Search.AllSearch;
-using CompaniesHouse.Response.Search.CompanySearch;
 using CompaniesHouse.Response.Search.DisqualifiedOfficersSearch;
 using CompaniesHouse.Response.Search.OfficerSearch;
 using CompaniesHouse.UriBuilders;
+using CompanySearch = CompaniesHouse.Response.Search.CompanySearch.CompanySearch;
 using Officer = CompaniesHouse.Response.Officers.Officer;
 
 namespace CompaniesHouse
@@ -56,9 +57,9 @@ public CompaniesHouseClient(ICompaniesHouseSettings settings)
             return _companiesHouseSearchClient.SearchAsync<SearchCompanyRequest, CompanySearch>(request, cancellationToken);
         }
 
-        public Task<CompaniesHouseClientResponse<CompanySearch>> SearchCompanyAdvancedAsync(AdvancedSearchCompanyRequest request, CancellationToken cancellationToken = default(CancellationToken))
+        public Task<CompaniesHouseClientResponse<AdvancedCompanySearch>> SearchCompanyAdvancedAsync(AdvancedSearchCompanyRequest request, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return _companiesHouseSearchClient.SearchAsync<AdvancedSearchCompanyRequest, CompanySearch>(request, cancellationToken);
+            return _companiesHouseSearchClient.SearchAsync<AdvancedSearchCompanyRequest, AdvancedCompanySearch>(request, cancellationToken);
         }
 
         public Task<CompaniesHouseClientResponse<OfficerSearch>> SearchOfficerAsync(SearchOfficerRequest request, CancellationToken cancellationToken = default(CancellationToken))

src/CompaniesHouse/CompaniesHouseSearchClient.cs

@@ -18,7 +18,8 @@ public CompaniesHouseSearchClient(HttpClient httpClient, ISearchUriBuilderFactor
             _searchUriBuilderFactory = searchUriBuilderFactory;
         }
 
-        public async Task<CompaniesHouseClientResponse<TReturn>> SearchAsync<TSearchRequest, TReturn>(TSearchRequest request,
+        public async Task<CompaniesHouseClientResponse<TReturn>> SearchAsync<TSearchRequest, TReturn>(
+            TSearchRequest request,
             CancellationToken cancellationToken = default(CancellationToken))
             where TSearchRequest : SearchRequest<TReturn>
         {

src/CompaniesHouse/ICompaniesHouseSearchCompanyAdvancedClient.cs

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

src/CompaniesHouse/JsonConverters/SearchItemConverter.cs

@@ -1,5 +1,6 @@
 using System;
 using CompaniesHouse.Response.Search;
+using CompaniesHouse.Response.Search.AdvancedCompanySearch;
 using CompaniesHouse.Response.Search.CompanySearch;
 using CompaniesHouse.Response.Search.DisqualifiedOfficersSearch;
 using CompaniesHouse.Response.Search.OfficerSearch;
@@ -13,10 +14,14 @@ public class SearchItemConverter : JsonCreationConverter<SearchItem>
         protected override SearchItem Create(Type objectType, JObject jObject)
         {
             var kind = jObject.Value<string>("kind");
-            if (kind is "searchresults#company" or "search-results#company")
+            if (kind is "searchresults#company")
             {
                 return new Company();
             }
+            if (kind is "search-results#company")
+            {
+                return new AdvancedSearchedCompany();
+            }
             else if (kind is "searchresults#officer")
             {
                 return new Officer();

src/CompaniesHouse/Request/AdvancedSearchCompanyRequest.cs

@@ -1,10 +1,11 @@
 #nullable enable
 using CompaniesHouse.Response;
+using CompaniesHouse.Response.Search.AdvancedCompanySearch;
 using CompaniesHouse.Response.Search.CompanySearch;
 
 namespace CompaniesHouse.Request;
 
-public class AdvancedSearchCompanyRequest : SearchRequest<CompanySearch>
+public class AdvancedSearchCompanyRequest : SearchRequest<AdvancedCompanySearch>
 {
     public string? CompanyNameIncludes { get; set; }
     public string? CompanyNameExcludes { get; set; }

src/CompaniesHouse/Response/Search/AdvancedCompanySearch/AdvancedCompanySearch.cs

@@ -0,0 +1,22 @@
+using Newtonsoft.Json;
+
+namespace CompaniesHouse.Response.Search.AdvancedCompanySearch
+{
+    public class AdvancedCompanySearch
+    {
+        [JsonProperty(PropertyName = "etag")]
+        public string ETag { get; set; }
+
+        [JsonProperty(PropertyName = "items")]
+        public AdvancedSearchedCompany[] Companies { get; set; }
+
+        [JsonProperty(PropertyName = "kind")]
+        public string Kind { get; set; }
+
+        [JsonProperty(PropertyName = "hits")]
+        public int? Hits { get; set; }
+
+        [JsonProperty(PropertyName = "top_hit")]
+        public AdvancedSearchedCompany TopHit { get; set; }
+    }
+}

src/CompaniesHouse/Response/Search/AdvancedCompanySearch/AdvancedSearchedCompany.cs

@@ -0,0 +1,39 @@
+using CompaniesHouse.JsonConverters;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+
+namespace CompaniesHouse.Response.Search.AdvancedCompanySearch;
+
+public class AdvancedSearchedCompany : SearchItem
+{
+    [JsonProperty(PropertyName = "company_name")]
+    public string CompanyName { get; set; }
+        
+    [JsonProperty(PropertyName = "registered_office_address")]
+    public Address RegisteredOfficeAddress { get; set; }
+
+    [JsonProperty(PropertyName = "company_number")]
+    public string CompanyNumber { get; set; }
+
+    [JsonProperty(PropertyName = "company_status")]
+    [JsonConverter(typeof(OptionalStringEnumConverter<CompanyStatus>), CompanyStatus.None)]
+    public CompanyStatus CompanyStatus { get; set; }
+
+    [JsonProperty(PropertyName = "company_type")]
+    [JsonConverter(typeof(StringEnumConverter))]
+    public CompanyType CompanyType { get; set; }
+        
+    [JsonProperty(PropertyName = "company_subtype")]
+    [JsonConverter(typeof(StringEnumConverter))]
+    public CompanySubType CompanySubType { get; set; }
+        
+    [JsonProperty(PropertyName = "date_of_cessation")]
+    [JsonConverter(typeof(OptionalDateJsonConverter))]
+    public DateTime? DateOfCessation { get; set; }
+
+    [JsonProperty(PropertyName = "date_of_creation")]
+    public DateTime? DateOfCreation { get; set; }
+
+    [JsonProperty(PropertyName = "sic_codes")]
+    public string[] SicCodes { get; set; }
+}

tests/CompaniesHouse.IntegrationTests/Tests/SearchingTests/CompanySearchAdvancedTests.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Threading.Tasks;
 using CompaniesHouse.Request;
+using CompaniesHouse.Response.Search.AdvancedCompanySearch;
 using CompaniesHouse.Response.Search.CompanySearch;
 using NUnit.Framework;
 
@@ -13,7 +14,7 @@ public class CompanySearchAdvancedTests
     {
         private readonly string _query;
         private CompaniesHouseClient _client;
-        private CompaniesHouseClientResponse<CompanySearch> _result;
+        private CompaniesHouseClientResponse<AdvancedCompanySearch> _result;
 
         public CompanySearchAdvancedTests(string query)
         {