U #iK@sddlmZddlmZmZmZmZmZddlm Z ddl m Z ddl m Z mZddlmZddlmZmZmZmZmZmZmZGd d d Zd S) ) annotations)AnyDictListOptionalUnion) parse_obj_as)APIError)check_responseencode_uri_component) SyncClient) CookieOptionsLinkTypeProviderSessionUserUserAttributes-determine_session_or_user_model_from_responsec @seZdZdddddddddd d d d d ZddddZd dddZd dddZdddddZddddZdddddd ddd d!d"Z dd#ddd d$d%d&d'Z dd(ddddd)d*d+Z ddd$d,d-d.Z dd#ddd d d/d0d1Z ddd d2d3d4Zdd#ddd dd5d6d7Zddddd ddd8d9d:Zdd#dd d d;dd?d@Zdd d>dAdBZdddCdDd d ddEdFdGZddd>dHdIZddddJdKdLZdMdNdddd dOdPdQZdd$dRdSdTZddddUdVdd d dddWdXdYZdZd[Zd\d]ZdS)^ SyncGoTrueAPINT) http_clientverifyproxystrzDict[str, str]rzOptional[SyncClient]boolz Optional[str]None)urlheaderscookie_optionsrrrreturncCs0||_||_||_|p(tt||ddd|_dS)zInitialise API class.T)rrZfollow_redirectsZhttp2N)rrrr rr)selfrrrrrrr!4/tmp/pip-unpacked-wheel-b8wmx3ip/gotrue/_sync/api.py__init__s zSyncGoTrueAPI.__init__)rcCs|SNr!r r!r!r" __enter__+szSyncGoTrueAPI.__enter__cCs |dSr$)close)r Zexc_tZexc_vexc_tbr!r!r"__exit__.szSyncGoTrueAPI.__exit__cCs|jdSr$)racloser%r!r!r"r'1szSyncGoTrueAPI.closerr) attributesrcCs6|j}|}|jd}|jj|||d}t|S)aCreates a new user. This function should only be called on a server. Never expose your `service_role` key in the browser. Parameters ---------- attributes: UserAttributes The data you want to create the user with. Returns ------- response : User The created user Raises ------ APIError If an error occurs. /admin/usersjsonr)rdictrrpostrparse_response)r r+rdatarresponser!r!r" create_user4s  zSyncGoTrueAPI.create_userz List[User]cCsl|j}|jd}|jj||d}t||d}|dkrJtddt|ts^tddt t t |S)a?Get a list of users. This function should only be called on a server. Never expose your `service_role` key in the browser. Returns ------- response : List[User] A list of users Raises ------ APIError If an error occurs. r,rusersNzNo users found in responseizExpected a list of users) rrrgetr r.r isinstancelistrrr)r rrr3r6r!r!r" list_usersOs    zSyncGoTrueAPI.list_users) redirect_tor2zOptional[Dict[str, Any]]zUnion[Session, User])emailpasswordr;r2rc Cs`|j}d}|r t|}d|}|||d}|jd|}|jj|||d} t| } | | S)aCreates a new user using their email address. Parameters ---------- email : str The email address of the user. password : str The password of the user. redirect_to : Optional[str] A URL or mobile address to send the user to after they are confirmed. data : Optional[Dict[str, Any]] Optional user metadata. Returns ------- response : Union[Session, User] A logged-in session if the server has "autoconfirm" ON A user if the server has "autoconfirm" OFF Raises ------ APIError If an error occurs. ?redirect_to=)r<r=r2/signupr-rr rrr0rr1) r r<r=r;r2r query_stringredirect_to_encodedrr3session_or_user_modelr!r!r"sign_up_with_emailjs   z SyncGoTrueAPI.sign_up_with_email)r;r)r<r=r;rc CsZ|j}d}|r$t|}|d|7}||d}|jd|}|jj|||d} t| S)aLogs in an existing user using their email address. Parameters ---------- email : str The email address of the user. password : str The password of the user. redirect_to : Optional[str] A URL or mobile address to send the user to after they are confirmed. Returns ------- response : Session A logged-in session Raises ------ APIError If an error occurs. z?grant_type=passwordz &redirect_to=)r<r=z/tokenr-)rr rrr0rr1) r r<r=r;rrBrCr2rr3r!r!r"sign_in_with_emails z SyncGoTrueAPI.sign_in_with_email)r2)phoner=r2rcCsB|j}|||d}|jd}|jj|||d}t|}||S)aFSigns up a new user using their phone number and a password. Parameters ---------- phone : str The phone number of the user. password : str The password of the user. data : Optional[Dict[str, Any]] Optional user metadata. Returns ------- response : Union[Session, User] A logged-in session if the server has "autoconfirm" ON A user if the server has "autoconfirm" OFF Raises ------ APIError If an error occurs. )rGr=r2r@r-)rrrr0rr1)r rGr=r2rrr3rDr!r!r"sign_up_with_phones   z SyncGoTrueAPI.sign_up_with_phone)rGr=rcCs8||d}|jd}|j}|jj|||d}t|S)aLogs in an existing user using their phone number and password. Parameters ---------- phone : str The phone number of the user. password : str The password of the user. Returns ------- response : Session A logged-in session Raises ------ APIError If an error occurs. )rGr=z/token?grant_type=passwordr-rrrr0rr1)r rGr=r2rrr3r!r!r"sign_in_with_phones   z SyncGoTrueAPI.sign_in_with_phone)r<r4r;rc CsT|j}d}|r t|}d|}||d}|jd|}|jj|||d} t| S)abSends a magic login link to an email address. Parameters ---------- email : str The email address of the user. redirect_to : Optional[str] A URL or mobile address to send the user to after they are confirmed. Raises ------ APIError If an error occurs. r>r?)r<r4z /magiclinkr-rr rrr0r ) r r<r4r;rrBrCr2rr3r!r!r"send_magic_link_emails  z#SyncGoTrueAPI.send_magic_link_email)rGr4rcCs6|j}||d}|jd}|jj|||d}t|S)a#Sends a mobile OTP via SMS. Will register the account if it doesn't already exist Parameters ---------- phone : str The user's phone number WITH international prefix Raises ------ APIError If an error occurs. )rGr4z/otpr-)rrrr0r )r rGr4rr2rr3r!r!r"send_mobile_otps   zSyncGoTrueAPI.send_mobile_otp)rGtokenr;rc CsV|j}||dd}|r&t|}||d<|jd}|jj|||d}t|} | |S)aSend User supplied Mobile OTP to be verified Parameters ---------- phone : str The user's phone number WITH international prefix token : str Token that user was sent to their mobile phone redirect_to : Optional[str] A URL or mobile address to send the user to after they are confirmed. Returns ------- response : Union[Session, User] A logged-in session if the server has "autoconfirm" ON A user if the server has "autoconfirm" OFF Raises ------ APIError If an error occurs. Zsms)rGrNtyper;z/verifyr-rA) r rGrNr;rr2rCrr3rDr!r!r"verify_mobile_otp1s zSyncGoTrueAPI.verify_mobile_otp)r<r;r2rc CsV|j}d}|r t|}d|}||d}|jd|}|jj|||d}t|S)aSends an invite link to an email address. Parameters ---------- email : str The email address of the user. redirect_to : Optional[str] A URL or mobile address to send the user to after they are confirmed. data : Optional[Dict[str, Any]] Optional user metadata. Returns ------- response : User A user Raises ------ APIError If an error occurs. r>r?)r<r2z/inviter-)rr rrr0rr1) r r<r;r2rrBrCrr3r!r!r"invite_user_by_email\s  z"SyncGoTrueAPI.invite_user_by_email)r<r;rc CsR|j}d}|r t|}d|}d|i}|jd|}|jj|||d}t|S)a_Sends a reset request to an email address. Parameters ---------- email : str The email address of the user. redirect_to : Optional[str] A URL or mobile address to send the user to after they are confirmed. Raises ------ APIError If an error occurs. r>r?r<z/recoverr-rK) r r<r;rrBrCr2rr3r!r!r"reset_password_for_emails z&SyncGoTrueAPI.reset_password_for_email)jwtrcCs|jdd|i}|S)aCreate temporary object. Create a temporary object with all configured headers and adds the Authorization token to be used on request methods. Parameters ---------- jwt : str A valid, logged-in JWT. Returns ------- headers : dict of str The headers required for a successful request statement with the supabase backend. AuthorizationzBearer r5)r rSrr!r!r"_create_request_headerssz%SyncGoTrueAPI._create_request_headerscCs,|j|d}|jd}|jj||ddS)zRemoves a logged-in session. Parameters ---------- jwt : str A valid, logged-in JWT. rSz/logoutr5N)rUrrr0)r rSrrr!r!r"sign_outs  zSyncGoTrueAPI.sign_out)r;scopesr)providerr;rXrcCsZdt|g}|r,t|}|d||rD|dt||jdd|S)aRGenerates the relevant login URL for a third-party provider. Parameters ---------- provider : Provider One of the providers supported by GoTrue. redirect_to : Optional[str] A URL or mobile address to send the user to after they are confirmed. scopes : Optional[str] A space-separated list of scopes granted to the OAuth application. Returns ------- url : str The URL to redirect the user to. Raises ------ APIError If an error occurs. z provider=z redirect_to=zscopes=z /authorize?&)r appendrjoin)r rYr;rXZ url_paramsrCr!r!r"get_url_for_providersz"SyncGoTrueAPI.get_url_for_providercCs2|j|d}|jd}|jj||d}t|S)aGets the user details. Parameters ---------- jwt : str A valid, logged-in JWT. Returns ------- response : User A user Raises ------ APIError If an error occurs. rV/userr5)rUrrr7rr1)r rSrrr3r!r!r"get_users  zSyncGoTrueAPI.get_user)rSr+rcCs<|j|d}|}|jd}|jj|||d}t|S)an Updates the user data. Parameters ---------- jwt : str A valid, logged-in JWT. attributes : UserAttributes The data you want to update. Returns ------- response : User A user Raises ------ APIError If an error occurs. rVr^r-)rUr/rrputrr1)r rSr+rr2rr3r!r!r" update_users   zSyncGoTrueAPI.update_userF)should_soft_delete)uidrSrbrcCs>|j|d}|jd|}d|i}|jj|||d}t|S)aUDelete a user. Requires a `service_role` key. This function should only be called on a server. Never expose your `service_role` key in the browser. Parameters ---------- uid : str The user uid you want to remove. jwt : str A valid, logged-in JWT. should_soft_delete : bool If true, then the user will be soft-deleted from the auth schema. Returns ------- response : User A user Raises ------ APIError If an error occurs. rVz /admin/users/rbr-)rUrrdeleter )r rcrSrbrrbodyr3r!r!r" delete_users zSyncGoTrueAPI.delete_user) refresh_tokenrcCs6d|i}|jd}|j}|jj|||d}t|S)a@Generates a new JWT. Parameters ---------- refresh_token : str A valid refresh token that was returned on login. Returns ------- response : Session A session Raises ------ APIError If an error occurs. rgz/token?grant_type=refresh_tokenr-rI)r rgr2rrr3r!r!r"refresh_access_token>s  z"SyncGoTrueAPI.refresh_access_token)r=r;r2r)rOr<r=r;r2rc Csb|j}|||d}|r||d<|r2t|}||d<|jd}|jj|||d} t| } | | S)a0 Generates links to be sent via email or other. Parameters ---------- type : LinkType The link type ("signup" or "magiclink" or "recovery" or "invite"). email : str The user's email. password : Optional[str] User password. For signup only. redirect_to : Optional[str] The link type ("signup" or "magiclink" or "recovery" or "invite"). data : Optional[Dict[str, Any]] Optional user metadata. For signup only. Returns ------- response : Union[Session, User] A logged-in session if the server has "autoconfirm" ON A user if the server has "autoconfirm" OFF Raises ------ APIError If an error occurs. )rOr<r2r=r;z/admin/generate_linkr-rA) r rOr<r=r;r2rrCrr3rDr!r!r" generate_linkVs$ zSyncGoTrueAPI.generate_linkcCs tddS)Stub for parity with JS api.z set_auth_cookie not implemented.NNotImplementedError)r reqresr!r!r"set_auth_cookieszSyncGoTrueAPI.set_auth_cookiecCs tddS)rjz#get_user_by_cookie not implemented.Nrk)r rmr!r!r"get_user_by_cookiesz SyncGoTrueAPI.get_user_by_cookie)__name__ __module__ __qualname__r#r&r)r'r4r:rErFrHrJrLrMrPrQrRrUrWr]r_rarfrhrirorpr!r!r!r"rsV 0,$$/*$!#4rN) __future__rtypingrrrrrZpydanticr exceptionsr Zhelpersr r Z http_clientsr typesrrrrrrrrr!r!r!r"s    $