Retrieve multiple contacts in a single API call

Resolves #385
Jericho · Apr 13, 2021 · 752d27a · 752d27a
1 parent 6cf2782
commit 752d27a
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/Source/StrongGrid.IntegrationTests/Tests/ContactsAndCustomFields.cs b/Source/StrongGrid.IntegrationTests/Tests/ContactsAndCustomFields.cs
@@ -84,6 +84,13 @@ public async Task RunAsync(IClient client, TextWriter log, CancellationToken can
 
 			if (contacts.Any())
 			{
+				var batch = await client.Contacts.GetMultipleAsync(contacts.Take(10).Select(c => c.Id), cancellationToken).ConfigureAwait(false);
+				await log.WriteLineAsync($"Retrieved {batch.Length} contacts in a single API call.").ConfigureAwait(false);
+				foreach (var record in batch)
+				{
+					await log.WriteLineAsync($"\t{record.FirstName} {record.LastName}").ConfigureAwait(false);
+				}
+
 				var contact = await client.Contacts.GetAsync(contacts.First().Id).ConfigureAwait(false);
 				await log.WriteLineAsync($"Retrieved contact {contact.Id}").ConfigureAwait(false);
 				await log.WriteLineAsync($"\tEmail: {contact.Email}").ConfigureAwait(false);

diff --git a/Source/StrongGrid/Resources/Contacts.cs b/Source/StrongGrid/Resources/Contacts.cs
@@ -226,6 +226,28 @@ public Task<Contact> GetAsync(string contactId, CancellationToken cancellationTo
 				.AsObject<Contact>();
 		}
 
+		/// <summary>
+		/// Retrieve multiple contacts.
+		/// </summary>
+		/// <param name="contactIds">An enumeration of contact identifiers.</param>
+		/// <param name="cancellationToken">The cancellation token.</param>
+		/// <returns>
+		/// An array of <see cref="Contact" />.
+		/// </returns>
+		public Task<Contact[]> GetMultipleAsync(IEnumerable<string> contactIds, CancellationToken cancellationToken = default)
+		{
+			var data = new JObject()
+			{
+				{ "ids", new JArray(contactIds) }
+			};
+
+			return _client
+				.PostAsync($"{_endpoint}/batch")
+				.WithJsonBody(data)
+				.WithCancellationToken(cancellationToken)
+				.AsObject<Contact[]>("result");
+		}
+
 		/// <summary>
 		/// Searches for contacts matching the specified conditions.
 		/// </summary>

diff --git a/Source/StrongGrid/Resources/IContacts.cs b/Source/StrongGrid/Resources/IContacts.cs
@@ -127,6 +127,16 @@ Task<string> UpsertAsync(
 		/// </returns>
 		Task<Contact> GetAsync(string contactId, CancellationToken cancellationToken = default);
 
+		/// <summary>
+		/// Retrieve multiple contacts.
+		/// </summary>
+		/// <param name="contactIds">An enumeration of contact identifiers.</param>
+		/// <param name="cancellationToken">The cancellation token.</param>
+		/// <returns>
+		/// An array of <see cref="Contact" />.
+		/// </returns>
+		Task<Contact[]> GetMultipleAsync(IEnumerable<string> contactIds, CancellationToken cancellationToken = default);
+
 		/// <summary>
 		/// Searches for contacts matching the specified conditions.
 		/// </summary>