Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add resend method #587

Merged
merged 2 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions supabase_auth/_async/gotrue_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
OAuthResponse,
Options,
Provider,
ResendCredentials,
Session,
SignInAnonymouslyCredentials,
SignInWithIdTokenCredentials,
Expand Down Expand Up @@ -519,6 +520,41 @@ async def sign_in_with_otp(
"You must provide either an email or phone number"
)

async def resend(
self,
credentials: ResendCredentials,
) -> AuthOtpResponse:
"""
Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP.
"""
email = credentials.get("email")
phone = credentials.get("phone")
type = credentials.get("type")
options = credentials.get("options", {})
email_redirect_to = options.get("email_redirect_to")
captcha_token = options.get("captcha_token")
body = {
"type": type,
"gotrue_meta_security": {
"captcha_token": captcha_token,
},
}

if email is None and phone is None:
raise AuthInvalidCredentialsError(
"You must provide either an email or phone number"
)

body.update({"email": email} if email else {"phone": phone})

return await self._request(
"POST",
"resend",
body=body,
redirect_to=email_redirect_to if email else None,
xform=parse_auth_otp_response,
)

async def verify_otp(self, params: VerifyOtpParams) -> AuthResponse:
"""
Log in a user given a User supplied OTP received via mobile.
Expand Down
36 changes: 36 additions & 0 deletions supabase_auth/_sync/gotrue_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
OAuthResponse,
Options,
Provider,
ResendCredentials,
Session,
SignInAnonymouslyCredentials,
SignInWithIdTokenCredentials,
Expand Down Expand Up @@ -513,6 +514,41 @@ def sign_in_with_otp(
"You must provide either an email or phone number"
)

def resend(
self,
credentials: ResendCredentials,
) -> AuthOtpResponse:
"""
Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP.
"""
email = credentials.get("email")
phone = credentials.get("phone")
type = credentials.get("type")
options = credentials.get("options", {})
email_redirect_to = options.get("email_redirect_to")
captcha_token = options.get("captcha_token")
body = {
"type": type,
"gotrue_meta_security": {
"captcha_token": captcha_token,
},
}

if email is None and phone is None:
raise AuthInvalidCredentialsError(
"You must provide either an email or phone number"
)

body.update({"email": email} if email else {"phone": phone})

return self._request(
"POST",
"resend",
body=body,
redirect_to=email_redirect_to if email else None,
xform=parse_auth_otp_response,
)

def verify_otp(self, params: VerifyOtpParams) -> AuthResponse:
"""
Log in a user given a User supplied OTP received via mobile.
Expand Down
24 changes: 24 additions & 0 deletions supabase_auth/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,30 @@ class SignInWithPhoneAndPasswordlessCredentials(TypedDict):
]


class ResendEmailCredentialsOptions(TypedDict):
email_redirect_to: NotRequired[str]
captcha_token: NotRequired[str]


class ResendEmailCredentials(TypedDict):
type: Literal["signup", "email_change"]
email: str
options: NotRequired[ResendEmailCredentialsOptions]


class ResendPhoneCredentialsOptions(TypedDict):
captcha_token: NotRequired[str]


class ResendPhoneCredentials(TypedDict):
type: Literal["sms", "phone_change"]
phone: str
options: NotRequired[ResendPhoneCredentialsOptions]


ResendCredentials = Union[ResendEmailCredentials, ResendPhoneCredentials]


class SignInWithOAuthCredentialsOptions(TypedDict):
redirect_to: NotRequired[str]
scopes: NotRequired[str]
Expand Down
Loading