pangea-sdk 3.8.0__py3-none-any.whl → 5.3.0__py3-none-any.whl

pangea/asyncio/services/authn.py

@@ -7,7 +7,7 @@ from typing import Dict, List, Optional, Union
 import pangea.services.authn.models as m
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
-from pangea.response import PangeaResponse
+from pangea.response import PangeaResponse, PangeaResponseResult
 
 SERVICE_NAME = "authn"
 
@@ -25,14 +25,14 @@ class AuthNAsync(ServiceBaseAsync):
         import os
 
         # Pangea SDK
+        from pangea.asyncio.services import AuthNAsync
         from pangea.config import PangeaConfig
-        from pangea.services import AuthN
 
         PANGEA_TOKEN = os.getenv("PANGEA_AUTHN_TOKEN")
         authn_config = PangeaConfig(domain="pangea.cloud")
 
         # Setup Pangea AuthN service
-        authn = AuthN(token=PANGEA_TOKEN, config=authn_config)
+        authn = AuthNAsync(token=PANGEA_TOKEN, config=authn_config)
     """
 
     service_name = SERVICE_NAME
@@ -96,7 +96,7 @@ class AuthNAsync(ServiceBaseAsync):
             """
             input = m.SessionInvalidateRequest(session_id=session_id)
             return await self.request.post(
-                "v2/session/invalidate", m.SessionInvalidateResult, data=input.dict(exclude_none=True)
+                "v2/session/invalidate", m.SessionInvalidateResult, data=input.model_dump(exclude_none=True)
             )
 
         async def list(
@@ -133,7 +133,9 @@ class AuthNAsync(ServiceBaseAsync):
                 filter = m.SessionListFilter(**filter)
 
             input = m.SessionListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
-            return await self.request.post("v2/session/list", m.SessionListResults, data=input.dict(exclude_none=True))
+            return await self.request.post(
+                "v2/session/list", m.SessionListResults, data=input.model_dump(exclude_none=True)
+            )
 
         async def logout(self, user_id: str) -> PangeaResponse[m.SessionLogoutResult]:
             """
@@ -156,7 +158,7 @@ class AuthNAsync(ServiceBaseAsync):
             """
             input = m.SessionLogoutRequest(user_id=user_id)
             return await self.request.post(
-                "v2/session/logout", m.SessionLogoutResult, data=input.dict(exclude_none=True)
+                "v2/session/logout", m.SessionLogoutResult, data=input.model_dump(exclude_none=True)
             )
 
     class ClientAsync(ServiceBaseAsync):
@@ -196,7 +198,7 @@ class AuthNAsync(ServiceBaseAsync):
             """
             input = m.ClientUserinfoRequest(code=code)
             return await self.request.post(
-                "v2/client/userinfo", m.ClientUserinfoResult, data=input.dict(exclude_none=True)
+                "v2/client/userinfo", m.ClientUserinfoResult, data=input.model_dump(exclude_none=True)
             )
 
         async def jwks(
@@ -253,7 +255,9 @@ class AuthNAsync(ServiceBaseAsync):
                 """
                 input = m.ClientSessionInvalidateRequest(token=token, session_id=session_id)
                 return await self.request.post(
-                    "v2/client/session/invalidate", m.ClientSessionInvalidateResult, data=input.dict(exclude_none=True)
+                    "v2/client/session/invalidate",
+                    m.ClientSessionInvalidateResult,
+                    data=input.model_dump(exclude_none=True),
                 )
 
             async def list(
@@ -297,7 +301,7 @@ class AuthNAsync(ServiceBaseAsync):
                     token=token, filter=filter, last=last, order=order, order_by=order_by, size=size
                 )
                 return await self.request.post(
-                    "v2/client/session/list", m.ClientSessionListResults, data=input.dict(exclude_none=True)
+                    "v2/client/session/list", m.ClientSessionListResults, data=input.model_dump(exclude_none=True)
                 )
 
             async def logout(self, token: str) -> PangeaResponse[m.ClientSessionLogoutResult]:
@@ -321,7 +325,7 @@ class AuthNAsync(ServiceBaseAsync):
                 """
                 input = m.ClientSessionLogoutRequest(token=token)
                 return await self.request.post(
-                    "v2/client/session/logout", m.ClientSessionLogoutResult, data=input.dict(exclude_none=True)
+                    "v2/client/session/logout", m.ClientSessionLogoutResult, data=input.model_dump(exclude_none=True)
                 )
 
             async def refresh(
@@ -351,7 +355,7 @@ class AuthNAsync(ServiceBaseAsync):
                 """
                 input = m.ClientSessionRefreshRequest(refresh_token=refresh_token, user_token=user_token)
                 return await self.request.post(
-                    "v2/client/session/refresh", m.ClientSessionRefreshResult, data=input.dict(exclude_none=True)
+                    "v2/client/session/refresh", m.ClientSessionRefreshResult, data=input.model_dump(exclude_none=True)
                 )
 
         class PasswordAsync(ServiceBaseAsync):
@@ -392,9 +396,28 @@ class AuthNAsync(ServiceBaseAsync):
                 """
                 input = m.ClientPasswordChangeRequest(token=token, old_password=old_password, new_password=new_password)
                 return await self.request.post(
-                    "v2/client/password/change", m.ClientPasswordChangeResult, data=input.dict(exclude_none=True)
+                    "v2/client/password/change", m.ClientPasswordChangeResult, data=input.model_dump(exclude_none=True)
                 )
 
+            async def expire(self, user_id: str) -> PangeaResponse[PangeaResponseResult]:
+                """
+                Expire a user's password
+
+                Expire a user's password.
+
+                OperationId: authn_post_v2_user_password_expire
+
+                Args:
+                    user_id: The identity of a user or a service.
+
+                Returns:
+                    A PangeaResponse with an empty object in the response.result field.
+
+                Examples:
+                    await authn.client.password.expire("pui_[...]")
+                """
+                return await self.request.post("v2/user/password/expire", PangeaResponseResult, {"id": user_id})
+
         class TokenAsync(ServiceBaseAsync):
             service_name = SERVICE_NAME
 
@@ -429,7 +452,7 @@ class AuthNAsync(ServiceBaseAsync):
                 """
                 input = m.ClientTokenCheckRequest(token=token)
                 return await self.request.post(
-                    "v2/client/token/check", m.ClientTokenCheckResult, data=input.dict(exclude_none=True)
+                    "v2/client/token/check", m.ClientTokenCheckResult, data=input.model_dump(exclude_none=True)
                 )
 
     class UserAsync(ServiceBaseAsync):
@@ -450,6 +473,8 @@ class AuthNAsync(ServiceBaseAsync):
             self,
             email: str,
             profile: m.Profile,
+            *,
+            username: str | None = None,
         ) -> PangeaResponse[m.UserCreateResult]:
             """
             Create User
@@ -459,8 +484,9 @@ class AuthNAsync(ServiceBaseAsync):
             OperationId: authn_post_v2_user_create
 
             Args:
-                email (str): An email address
-                profile (m.Profile): A user profile as a collection of string properties
+                email: An email address.
+                profile: A user profile as a collection of string properties.
+                username: A username.
 
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
@@ -479,11 +505,14 @@ class AuthNAsync(ServiceBaseAsync):
             input = m.UserCreateRequest(
                 email=email,
                 profile=profile,
+                username=username,
+            )
+            return await self.request.post(
+                "v2/user/create", m.UserCreateResult, data=input.model_dump(exclude_none=True)
             )
-            return await self.request.post("v2/user/create", m.UserCreateResult, data=input.dict(exclude_none=True))
 
         async def delete(
-            self, email: Optional[str] = None, id: Optional[str] = None
+            self, email: str | None = None, id: str | None = None, *, username: str | None = None
         ) -> PangeaResponse[m.UserDeleteResult]:
             """
             Delete User
@@ -493,8 +522,9 @@ class AuthNAsync(ServiceBaseAsync):
             OperationId: authn_post_v2_user_delete
 
             Args:
-                email (str, optional): An email address
-                id (str, optional): The id of a user or a service
+                email: An email address.
+                id: The id of a user or a service.
+                username: A username.
 
             Returns:
                 A PangeaResponse with an empty object in the response.result field.
@@ -502,8 +532,10 @@ class AuthNAsync(ServiceBaseAsync):
             Examples:
                 authn.user.delete(email="example@example.com")
             """
-            input = m.UserDeleteRequest(email=email, id=id)
-            return await self.request.post("v2/user/delete", m.UserDeleteResult, data=input.dict(exclude_none=True))
+            input = m.UserDeleteRequest(email=email, id=id, username=username)
+            return await self.request.post(
+                "v2/user/delete", m.UserDeleteResult, data=input.model_dump(exclude_none=True)
+            )
 
         async def invite(
             self,
@@ -544,13 +576,17 @@ class AuthNAsync(ServiceBaseAsync):
                 callback=callback,
                 state=state,
             )
-            return await self.request.post("v2/user/invite", m.UserInviteResult, data=input.dict(exclude_none=True))
+            return await self.request.post(
+                "v2/user/invite", m.UserInviteResult, data=input.model_dump(exclude_none=True)
+            )
 
         async def update(
             self,
             disabled: bool,
-            id: Optional[str] = None,
-            email: Optional[str] = None,
+            id: str | None = None,
+            email: str | None = None,
+            *,
+            username: str | None = None,
         ) -> PangeaResponse[m.UserUpdateResult]:
             """
             Update user's settings
@@ -560,10 +596,11 @@ class AuthNAsync(ServiceBaseAsync):
             OperationId: authn_post_v2_user_update
 
             Args:
-                disabled (bool): New disabled value.
+                disabled: New disabled value.
                     Disabling a user account will prevent them from logging in.
-                id (str, optional): The identity of a user or a service
-                email (str, optional): An email address
+                id: The identity of a user or a service.
+                email: An email address.
+                username: A username.
 
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
@@ -580,9 +617,12 @@ class AuthNAsync(ServiceBaseAsync):
                 id=id,
                 email=email,
                 disabled=disabled,
+                username=username,
             )
 
-            return await self.request.post("v2/user/update", m.UserUpdateResult, data=input.dict(exclude_none=True))
+            return await self.request.post(
+                "v2/user/update", m.UserUpdateResult, data=input.model_dump(exclude_none=True)
+            )
 
         async def list(
             self,
@@ -624,7 +664,7 @@ class AuthNAsync(ServiceBaseAsync):
                 order_by=order_by,
                 size=size,
             )
-            return await self.request.post("v2/user/list", m.UserListResult, data=input.dict(exclude_none=True))
+            return await self.request.post("v2/user/list", m.UserListResult, data=input.model_dump(exclude_none=True))
 
         class InvitesAsync(ServiceBaseAsync):
             service_name = SERVICE_NAME
@@ -671,7 +711,7 @@ class AuthNAsync(ServiceBaseAsync):
 
                 input = m.UserInviteListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
                 return await self.request.post(
-                    "v2/user/invite/list", m.UserInviteListResult, data=input.dict(exclude_none=True)
+                    "v2/user/invite/list", m.UserInviteListResult, data=input.model_dump(exclude_none=True)
                 )
 
             async def delete(self, id: str) -> PangeaResponse[m.UserInviteDeleteResult]:
@@ -695,7 +735,7 @@ class AuthNAsync(ServiceBaseAsync):
                 """
                 input = m.UserInviteDeleteRequest(id=id)
                 return await self.request.post(
-                    "v2/user/invite/delete", m.UserInviteDeleteResult, data=input.dict(exclude_none=True)
+                    "v2/user/invite/delete", m.UserInviteDeleteResult, data=input.model_dump(exclude_none=True)
                 )
 
         class AuthenticatorsAsync(ServiceBaseAsync):
@@ -710,7 +750,12 @@ class AuthNAsync(ServiceBaseAsync):
                 super().__init__(token, config, logger_name=logger_name)
 
             async def delete(
-                self, authenticator_id: str, id: Optional[str] = None, email: Optional[str] = None
+                self,
+                authenticator_id: str,
+                id: str | None = None,
+                email: str | None = None,
+                *,
+                username: str | None = None,
             ) -> PangeaResponse[m.UserAuthenticatorsDeleteResult]:
                 """
                 Delete user authenticator
@@ -720,9 +765,10 @@ class AuthNAsync(ServiceBaseAsync):
                 OperationId: authn_post_v2_user_authenticators_delete
 
                 Args:
-                    authenticator_id (str): An ID for an authenticator
-                    id (str, optional): The identity of a user or a service
-                    email (str, optional): An email address
+                    authenticator_id: An ID for an authenticator.
+                    id: The identity of a user or a service.
+                    email: An email address.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with an empty object in the response.result field.
@@ -733,15 +779,17 @@ class AuthNAsync(ServiceBaseAsync):
                         id="pui_xpkhwpnz2cmegsws737xbsqnmnuwtbm5",
                     )
                 """
-                input = m.UserAuthenticatorsDeleteRequest(authenticator_id=authenticator_id, email=email, id=id)
+                input = m.UserAuthenticatorsDeleteRequest(
+                    authenticator_id=authenticator_id, email=email, id=id, username=username
+                )
                 return await self.request.post(
                     "v2/user/authenticators/delete",
                     m.UserAuthenticatorsDeleteResult,
-                    data=input.dict(exclude_none=True),
+                    data=input.model_dump(exclude_none=True),
                 )
 
             async def list(
-                self, email: Optional[str] = None, id: Optional[str] = None
+                self, email: str | None = None, id: str | None = None, *, username: str | None = None
             ) -> PangeaResponse[m.UserAuthenticatorsListResult]:
                 """
                 Get user authenticators
@@ -751,8 +799,9 @@ class AuthNAsync(ServiceBaseAsync):
                 OperationId: authn_post_v2_user_authenticators_list
 
                 Args:
-                    email (str, optional): An email address
-                    id (str, optional): The identity of a user or a service
+                    email: An email address.
+                    id: The identity of a user or a service.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with a list of authenticators in the response.result field.
@@ -764,9 +813,11 @@ class AuthNAsync(ServiceBaseAsync):
                         id="pui_xpkhwpnz2cmegsws737xbsqnmnuwtbm5",
                     )
                 """
-                input = m.UserAuthenticatorsListRequest(email=email, id=id)
+                input = m.UserAuthenticatorsListRequest(email=email, id=id, username=username)
                 return await self.request.post(
-                    "v2/user/authenticators/list", m.UserAuthenticatorsListResult, data=input.dict(exclude_none=True)
+                    "v2/user/authenticators/list",
+                    m.UserAuthenticatorsListResult,
+                    data=input.model_dump(exclude_none=True),
                 )
 
         class ProfileAsync(ServiceBaseAsync):
@@ -781,7 +832,7 @@ class AuthNAsync(ServiceBaseAsync):
                 super().__init__(token, config, logger_name=logger_name)
 
             async def get(
-                self, id: Optional[str] = None, email: Optional[str] = None
+                self, id: str | None = None, email: str | None = None, *, username: str | None = None
             ) -> PangeaResponse[m.UserProfileGetResult]:
                 """
                 Get user
@@ -791,8 +842,9 @@ class AuthNAsync(ServiceBaseAsync):
                 OperationId: authn_post_v2_user_profile_get
 
                 Args:
-                    id (str, optional): The identity of a user or a service
-                    email (str, optional): An email address
+                    id: The identity of a user or a service.
+                    email: An email address.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
@@ -804,16 +856,18 @@ class AuthNAsync(ServiceBaseAsync):
                         email="joe.user@email.com",
                     )
                 """
-                input = m.UserProfileGetRequest(id=id, email=email)
+                input = m.UserProfileGetRequest(id=id, email=email, username=username)
                 return await self.request.post(
-                    "v2/user/profile/get", m.UserProfileGetResult, data=input.dict(exclude_none=True)
+                    "v2/user/profile/get", m.UserProfileGetResult, data=input.model_dump(exclude_none=True)
                 )
 
             async def update(
                 self,
                 profile: m.Profile,
-                id: Optional[str] = None,
-                email: Optional[str] = None,
+                id: str | None = None,
+                email: str | None = None,
+                *,
+                username: str | None = None,
             ) -> PangeaResponse[m.UserProfileUpdateResult]:
                 """
                 Update user
@@ -823,9 +877,10 @@ class AuthNAsync(ServiceBaseAsync):
                 OperationId: authn_post_v2_user_profile_update
 
                 Args:
-                    profile (m.Profile): Updates to a user profile
-                    id (str, optional): The identity of a user or a service
-                    email (str, optional): An email address
+                    profile: Updates to a user profile.
+                    id: The identity of a user or a service.
+                    email: An email address.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
@@ -844,9 +899,10 @@ class AuthNAsync(ServiceBaseAsync):
                     id=id,
                     email=email,
                     profile=profile,
+                    username=username,
                 )
                 return await self.request.post(
-                    "v2/user/profile/update", m.UserProfileUpdateResult, data=input.dict(exclude_none=True)
+                    "v2/user/profile/update", m.UserProfileUpdateResult, data=input.model_dump(exclude_none=True)
                 )
 
     class FlowAsync(ServiceBaseAsync):
@@ -882,7 +938,9 @@ class AuthNAsync(ServiceBaseAsync):
                 )
             """
             input = m.FlowCompleteRequest(flow_id=flow_id)
-            return await self.request.post("v2/flow/complete", m.FlowCompleteResult, data=input.dict(exclude_none=True))
+            return await self.request.post(
+                "v2/flow/complete", m.FlowCompleteResult, data=input.model_dump(exclude_none=True)
+            )
 
         async def restart(
             self, flow_id: str, choice: m.FlowChoice, data: m.FlowRestartData = {}
@@ -914,7 +972,9 @@ class AuthNAsync(ServiceBaseAsync):
             """
 
             input = m.FlowRestartRequest(flow_id=flow_id, choice=choice, data=data)
-            return await self.request.post("v2/flow/restart", m.FlowRestartResult, data=input.dict(exclude_none=True))
+            return await self.request.post(
+                "v2/flow/restart", m.FlowRestartResult, data=input.model_dump(exclude_none=True)
+            )
 
         async def start(
             self,
@@ -953,7 +1013,7 @@ class AuthNAsync(ServiceBaseAsync):
                 )
             """
             input = m.FlowStartRequest(cb_uri=cb_uri, email=email, flow_types=flow_types, invitation=invitation)
-            return await self.request.post("v2/flow/start", m.FlowStartResult, data=input.dict(exclude_none=True))
+            return await self.request.post("v2/flow/start", m.FlowStartResult, data=input.model_dump(exclude_none=True))
 
         async def update(
             self, flow_id: str, choice: m.FlowChoice, data: m.FlowUpdateData = {}
@@ -987,7 +1047,9 @@ class AuthNAsync(ServiceBaseAsync):
             """
 
             input = m.FlowUpdateRequest(flow_id=flow_id, choice=choice, data=data)
-            return await self.request.post("v2/flow/update", m.FlowUpdateResult, data=input.dict(exclude_none=True))
+            return await self.request.post(
+                "v2/flow/update", m.FlowUpdateResult, data=input.model_dump(exclude_none=True)
+            )
 
     class AgreementsAsync(ServiceBaseAsync):
         service_name = SERVICE_NAME
@@ -1031,7 +1093,7 @@ class AuthNAsync(ServiceBaseAsync):
 
             input = m.AgreementCreateRequest(type=type, name=name, text=text, active=active)
             return await self.request.post(
-                "v2/agreements/create", m.AgreementCreateResult, data=input.dict(exclude_none=True)
+                "v2/agreements/create", m.AgreementCreateResult, data=input.model_dump(exclude_none=True)
             )
 
         async def delete(self, type: m.AgreementType, id: str) -> PangeaResponse[m.AgreementDeleteResult]:
@@ -1058,7 +1120,7 @@ class AuthNAsync(ServiceBaseAsync):
 
             input = m.AgreementDeleteRequest(type=type, id=id)
             return await self.request.post(
-                "v2/agreements/delete", m.AgreementDeleteResult, data=input.dict(exclude_none=True)
+                "v2/agreements/delete", m.AgreementDeleteResult, data=input.model_dump(exclude_none=True)
             )
 
         async def list(
@@ -1096,7 +1158,7 @@ class AuthNAsync(ServiceBaseAsync):
 
             input = m.AgreementListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
             return await self.request.post(
-                "v2/agreements/list", m.AgreementListResult, data=input.dict(exclude_none=True)
+                "v2/agreements/list", m.AgreementListResult, data=input.model_dump(exclude_none=True)
             )
 
         async def update(
@@ -1137,5 +1199,5 @@ class AuthNAsync(ServiceBaseAsync):
 
             input = m.AgreementUpdateRequest(type=type, id=id, name=name, text=text, active=active)
             return await self.request.post(
-                "v2/agreements/update", m.AgreementUpdateResult, data=input.dict(exclude_none=True)
+                "v2/agreements/update", m.AgreementUpdateResult, data=input.model_dump(exclude_none=True)
             )