feat(auth): add whatsapp channel option to signInWithOTP (#287)

* feat(auth): add whatsapp channel option to signInWithOTP

* test: record changed snapshot test

Author: grdsdev

Sources/Auth/AuthClient.swift

@@ -425,11 +425,16 @@ public actor AuthClient {
   ///
   /// - Parameters:
   ///   - phone: User's phone with international prefix.
+  ///   - channel: Messaging channel to use (e.g `whatsapp` or `sms`), defaults to `sms`.
   ///   - shouldCreateUser: Creates a new user, defaults to `true`.
   ///   - data: User's metadata.
   ///   - captchaToken: Captcha verification token.
+  ///
+  /// - Note: You need to configure a WhatsApp sender on Twillo if you are using phone sign in with
+  /// the `whatsapp` channel.
   public func signInWithOTP(
     phone: String,
+    channel: MessagingChannel = .sms,
     shouldCreateUser: Bool = true,
     data: [String: AnyJSON]? = nil,
     captchaToken: String? = nil
@@ -443,6 +448,7 @@ public actor AuthClient {
           OTPParams(
             phone: phone,
             createUser: shouldCreateUser,
+            channel: channel,
             data: data,
             gotrueMetaSecurity: captchaToken.map(AuthMetaSecurity.init(captchaToken:))
           )

Sources/Auth/Types.swift

@@ -297,6 +297,7 @@ struct OTPParams: Codable, Hashable, Sendable {
   var email: String?
   var phone: String?
   var createUser: Bool
+  var channel: MessagingChannel?
   var data: [String: AnyJSON]?
   var gotrueMetaSecurity: AuthMetaSecurity?
   var codeChallenge: String?
@@ -658,3 +659,8 @@ public struct WeakPassword: Codable, Hashable, Sendable {
 struct DeleteUserRequest: Encodable {
   let shouldSoftDelete: Bool
 }
+
+public enum MessagingChannel: String, Codable, Sendable {
+  case sms
+  case whatsapp
+}

Tests/AuthTests/__Snapshots__/RequestsTests/testSignInWithOTPUsingPhone.1.txt

@@ -3,5 +3,5 @@ curl \
 	--header "Apikey: dummy.api.key" \
 	--header "Content-Type: application/json" \
 	--header "X-Client-Info: gotrue-swift/x.y.z" \
-	--data "{\"create_user\":true,\"data\":{\"custom_key\":\"custom_value\"},\"gotrue_meta_security\":{\"captcha_token\":\"dummy-captcha\"},\"phone\":\"+1 202-918-2132\"}" \
+	--data "{\"channel\":\"sms\",\"create_user\":true,\"data\":{\"custom_key\":\"custom_value\"},\"gotrue_meta_security\":{\"captcha_token\":\"dummy-captcha\"},\"phone\":\"+1 202-918-2132\"}" \
 	"http://localhost:54321/auth/v1/otp"