feat(mcm): has pending mappings (#683)

[changelog]
Get cluster pending (migrating, creating, deleting) mapping state.
Query cluster pending mapping status, and optionally get cluster mappings.

src/Algolia.Search.Test/EndToEnd/Index/MultiClusterManagementTest.cs

@@ -88,6 +88,10 @@ public async Task McmTest()
             }
 
             await RemovePastUserIDs();
+
+            var hasPendingMappings = await BaseTest.McmClient.HasPendingMappingsAsync(true);
+
+            Assert.That(hasPendingMappings, Is.Not.Null);
         }
 
         private async Task RemovePastUserIDs()

src/Algolia.Search/Clients/ISearchClient.cs

@@ -386,6 +386,23 @@ public interface ISearchClient
         Task<RemoveUserIdResponse> RemoveUserIdAsync(string userId, RequestOptions requestOptions = null,
             CancellationToken ct = default);
 
+        /// <summary>
+        /// Get cluster pending (migrating, creating, deleting) mapping state. Query cluster pending mapping status and get cluster mappings.
+        /// </summary>
+        /// <param name="retrieveMappings">Whether or not the cluster mappings should be retrieved</param>
+        /// <param name="requestOptions">Add extra http header or query parameters to Algolia</param>
+        HasPendingMappingsResponse HasPendingMappings(bool retrieveMappings = false,
+            RequestOptions requestOptions = null);
+
+        /// <summary>
+        /// Get cluster pending (migrating, creating, deleting) mapping state. Query cluster pending mapping status and get cluster mappings.
+        /// </summary>
+        /// <param name="retrieveMappings">Whether or not the cluster mappings should be retrieved</param>
+        /// <param name="requestOptions">Add extra http header or query parameters to Algolia</param>
+        /// <param name="ct">Optional cancellation token</param>
+        Task<HasPendingMappingsResponse> HasPendingMappingsAsync(bool retrieveMappings = false,
+            RequestOptions requestOptions = null, CancellationToken ct = default);
+
         /// <summary>
         /// Get the logs of the latest search and indexing operations
         /// You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

src/Algolia.Search/Clients/SearchClient.cs

@@ -537,6 +537,25 @@ public AssignUserIdResponse
                 .ConfigureAwait(false);
         }
 
+        /// <inheritdoc />
+        public HasPendingMappingsResponse HasPendingMappings(bool retrieveMappings = false,
+            RequestOptions requestOptions = null) =>
+            AsyncHelper.RunSync(() => HasPendingMappingsAsync(retrieveMappings, requestOptions));
+
+        /// <inheritdoc />
+        public async Task<HasPendingMappingsResponse> HasPendingMappingsAsync(bool retrieveMappings = false,
+            RequestOptions requestOptions = null, CancellationToken ct = default)
+        {
+            requestOptions = requestOptions.AddQueryParams(
+                new Dictionary<string, string> { { "getClusters", retrieveMappings.ToString().ToLower() } });
+
+            return await _transport.ExecuteRequestAsync<HasPendingMappingsResponse>(
+                    HttpMethod.Get,
+                    "/1/clusters/mapping/pending",
+                    CallType.Read, requestOptions, ct)
+                .ConfigureAwait(false);
+        }
+
         /// <inheritdoc />
         public LogResponse GetLogs(RequestOptions requestOptions = null, int offset = 0, int length = 10) =>
             AsyncHelper.RunSync(() =>

src/Algolia.Search/Models/Mcm/HasPendingMappingsResponse.cs

@@ -0,0 +1,44 @@
+/*
+* Copyright (c) 2018 Algolia
+* http://www.algolia.com/
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+using System;
+using System.Collections.Generic;
+
+namespace Algolia.Search.Models.Mcm
+{
+    /// <summary>
+    /// Describe cluster pending (migrating, creating, deleting) mapping state.
+    /// </summary>
+    public class HasPendingMappingsResponse
+    {
+        /// <summary>
+        /// Has clusters pending mapping in progress?
+        /// </summary>
+        public Boolean Pending { get; set; }
+
+        /// <summary>
+        /// Describe cluster pending (migrating, creating, deleting) mapping state.
+        /// </summary>
+        public Dictionary<string, IEnumerable<string>> Clusters { get; set; }
+    }
+}