Implements #81 - Adds InviteUserByEmailOptions as a parameter to the Gotrue Admin Client

Author: acupofjose

Gotrue/AdminClient.cs

@@ -57,9 +57,9 @@ public Func<Dictionary<string, string>>? GetHeaders
 		public Task<User?> GetUser(string jwt) => _api.GetUser(jwt);
 
 		/// <inheritdoc />
-		public async Task<bool> InviteUserByEmail(string email)
+		public async Task<bool> InviteUserByEmail(string email, InviteUserByEmailOptions? options = null)
 		{
-			var response = await _api.InviteUserByEmail(email, _serviceKey);
+			var response = await _api.InviteUserByEmail(email, _serviceKey, options);
 			response.ResponseMessage?.EnsureSuccessStatusCode();
 			return true;
 		}

Gotrue/Api.cs

@@ -257,11 +257,17 @@ public Task<BaseResponse> SendMagicLinkEmail(string email, SignInOptions? option
 		/// </summary>
 		/// <param name="email"></param>
 		/// <param name="jwt">this token needs role 'supabase_admin' or 'service_role'</param>
+		/// <param name="options"></param>
 		/// <returns></returns>
-		public Task<BaseResponse> InviteUserByEmail(string email, string jwt)
+		public Task<BaseResponse> InviteUserByEmail(string email, string jwt, InviteUserByEmailOptions? options = null)
 		{
-			var data = new Dictionary<string, string> { { "email", email } };
-			return Helpers.MakeRequest(HttpMethod.Post, $"{Url}/invite", data, CreateAuthedRequestHeaders(jwt));
+			var url = options == null || string.IsNullOrEmpty(options.RedirectTo) ? $"{Url}/invite" : $"{Url}/invite?redirect_to={options.RedirectTo}";
+			var body = new Dictionary<string, object> { { "email", email } };
+
+			if (options?.Data != null)
+				body["data"] = options.Data;
+			
+			return Helpers.MakeRequest(HttpMethod.Post, url, body, CreateAuthedRequestHeaders(jwt));
 		}
 
 		/// <summary>

Gotrue/Interfaces/IGotrueAdminClient.cs

@@ -51,8 +51,9 @@ public interface IGotrueAdminClient<TUser> : IGettableHeaders
 		/// Sends an email to the user.
 		/// </summary>
 		/// <param name="email"></param>
+		/// <param name="options"></param>
 		/// <returns></returns>
-		Task<bool> InviteUserByEmail(string email);
+		Task<bool> InviteUserByEmail(string email, InviteUserByEmailOptions? options = null);
 
 		/// <summary>
 		/// Lists users

Gotrue/Interfaces/IGotrueApi.cs

@@ -15,7 +15,7 @@ public interface IGotrueApi<TUser, TSession> : IGettableHeaders
 		Task<BaseResponse> DeleteUser(string uid, string jwt);
 		Task<TUser?> GetUser(string jwt);
 		Task<TUser?> GetUserById(string jwt, string userId);
-		Task<BaseResponse> InviteUserByEmail(string email, string jwt);
+		Task<BaseResponse> InviteUserByEmail(string email, string jwt, InviteUserByEmailOptions? options = null);
 		Task<UserList<TUser>?> ListUsers(string jwt, string? filter = null, string? sortBy = null, SortOrder sortOrder = SortOrder.Descending, int? page = null, int? perPage = null);
 		Task<TSession?> RefreshAccessToken(string accessToken, string refreshToken);
 		Task<BaseResponse> ResetPasswordForEmail(string email);

Gotrue/Interfaces/IGotrueStatelessClient.cs

@@ -76,15 +76,16 @@ public interface IGotrueStatelessClient<TUser, TSession>
         /// <param name="userId"></param>
         /// <returns></returns>
         Task<TUser?> GetUserById(string serviceRoleToken, StatelessClientOptions options, string userId);
-        
+
         /// <summary>
         /// Sends an invite email link to the specified email.
         /// </summary>
         /// <param name="email"></param>
         /// <param name="serviceRoleToken">this token needs role 'supabase_admin' or 'service_role'</param>
         /// <param name="options"></param>
+        /// <param name="inviteOptions"></param>
         /// <returns></returns>
-        Task<bool> InviteUserByEmail(string email, string serviceRoleToken, StatelessClientOptions options);
+        Task<bool> InviteUserByEmail(string email, string serviceRoleToken, StatelessClientOptions options, InviteUserByEmailOptions? inviteOptions = null);
 
         /// <summary>
         /// Lists users

Gotrue/InviteUserByEmailOptions.cs

@@ -0,0 +1,20 @@
+using System.Collections.Generic;
+
+namespace Supabase.Gotrue
+{
+	/// <summary>
+	/// A utility class that represents options for sending a User an Invitation
+	/// </summary>
+	public class InviteUserByEmailOptions
+	{
+		/// <summary>
+		/// The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL.
+		/// </summary>
+		public string? RedirectTo { get; set; }
+
+		/// <summary>
+		/// A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column.
+		/// </summary>
+		public Dictionary<string, object>? Data { get; set; }
+	}
+}

Gotrue/ResetPasswordForEmailOptions.cs

@@ -30,6 +30,10 @@ public class ResetPasswordForEmailOptions
 		/// </summary>
 		public string? PKCEVerifier { get; set; }
 
+		/// <summary>
+		/// Initializes a new instance of the <see cref="ResetPasswordForEmailOptions"/> class with the provided email.
+		/// </summary>
+		/// <param name="email">The email of the user account for which the password is being reset.</param>
 		public ResetPasswordForEmailOptions(string email)
 		{
 			Email = email;

Gotrue/StatelessClient.cs

@@ -130,9 +130,9 @@ public async Task<bool> SignOut(string accessToken, StatelessClientOptions optio
 		}
 
 		/// <inheritdoc />
-		public async Task<bool> InviteUserByEmail(string email, string serviceRoleToken, StatelessClientOptions options)
+		public async Task<bool> InviteUserByEmail(string email, string serviceRoleToken, StatelessClientOptions options, InviteUserByEmailOptions? invitationOptions = null)
 		{
-			var response = await GetApi(options).InviteUserByEmail(email, serviceRoleToken);
+			var response = await GetApi(options).InviteUserByEmail(email, serviceRoleToken, invitationOptions);
 			response.ResponseMessage?.EnsureSuccessStatusCode();
 			return true;
 		}