(GH-367) Teammates.GetAllPendingInvitationsAsync must return Paginate…

…dResponseWithLinks
Jericho · Jan 23, 2021 · 1c6ab01 · 1c6ab01
1 parent ac7f429
commit 1c6ab01
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 9 deletions.
diff --git a/Source/StrongGrid.IntegrationTests/Tests/Teammates.cs b/Source/StrongGrid.IntegrationTests/Tests/Teammates.cs
@@ -14,7 +14,7 @@ public async Task RunAsync(IBaseClient client, TextWriter log, CancellationToken
 
 			// GET ALL THE PENDING INVITATIONS
 			var pendingInvitation = await client.Teammates.GetAllPendingInvitationsAsync(cancellationToken).ConfigureAwait(false);
-			await log.WriteLineAsync($"There are {pendingInvitation.Length} pending invitations").ConfigureAwait(false);
+			await log.WriteLineAsync($"There are {pendingInvitation.Records.Length} pending invitations").ConfigureAwait(false);
 
 			// GET ALL THE TEAMMATES
 			var allTeammates = await client.Teammates.GetAllTeammatesAsync(50, 0, cancellationToken).ConfigureAwait(false);

diff --git a/Source/StrongGrid/Resources/ITeammates.cs b/Source/StrongGrid/Resources/ITeammates.cs
@@ -1,4 +1,4 @@
-using StrongGrid.Models;
+using StrongGrid.Models;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
@@ -63,12 +63,12 @@ public interface ITeammates
 		/// Retrieve a list of all pending teammate invitations.
 		/// </summary>
 		/// <param name="cancellationToken">The cancellation token.</param>
-		/// <returns>An array of <see cref="TeammateInvitation" />.</returns>
+		/// <returns>The <see cref="PaginatedResponseWithLinks{TeammateInvitation}" />.</returns>
 		/// <remarks>
 		/// Each teammate invitation is valid for 7 days.
 		/// Users may resend the invite to refresh the expiration date.
 		/// </remarks>
-		Task<TeammateInvitation[]> GetAllPendingInvitationsAsync(CancellationToken cancellationToken = default);
+		Task<PaginatedResponseWithLinks<TeammateInvitation>> GetAllPendingInvitationsAsync(CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Delete a pending teammate invite.

diff --git a/Source/StrongGrid/Resources/Teammates.cs b/Source/StrongGrid/Resources/Teammates.cs
@@ -1,7 +1,6 @@
-using Newtonsoft.Json.Linq;
+using Newtonsoft.Json.Linq;
 using Pathoschild.Http.Client;
 using StrongGrid.Models;
-using StrongGrid.Utilities;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
@@ -106,17 +105,17 @@ public Task ResendInvitationAsync(string token, CancellationToken cancellationTo
 		/// Retrieve a list of all pending teammate invitations.
 		/// </summary>
 		/// <param name="cancellationToken">The cancellation token.</param>
-		/// <returns>An array of <see cref="TeammateInvitation" />.</returns>
+		/// <returns>The <see cref="PaginatedResponseWithLinks{TeammateInvitation}" />.</returns>
 		/// <remarks>
 		/// Each teammate invitation is valid for 7 days.
 		/// Users may resend the invite to refresh the expiration date.
 		/// </remarks>
-		public Task<TeammateInvitation[]> GetAllPendingInvitationsAsync(CancellationToken cancellationToken = default)
+		public Task<PaginatedResponseWithLinks<TeammateInvitation>> GetAllPendingInvitationsAsync(CancellationToken cancellationToken = default)
 		{
 			return _client
 				.GetAsync($"{_endpoint}/pending")
 				.WithCancellationToken(cancellationToken)
-				.AsObject<TeammateInvitation[]>("result");
+				.AsPaginatedResponseWithLinks<TeammateInvitation>("result");
 		}
 
 		/// <summary>