Coverage for bc/kwai-bc-identity/src/kwai_bc_identity/user_invitations/user_invitation_query.py: 100%

1"""Module that defines an interface for a user invitation query.""" 

2 

3from abc import ABC 

4 

5from kwai_core.domain.repository.query import Query 

6from kwai_core.domain.value_objects.email_address import EmailAddress 

7from kwai_core.domain.value_objects.timestamp import Timestamp 

8from kwai_core.domain.value_objects.unique_id import UniqueId 

9 

10from kwai_bc_identity.user_invitations.user_invitation import ( 

11 UserInvitationIdentifier, 

12) 

13 

14 

15class UserInvitationQuery(Query, ABC): 

16 """An interface for querying user invitations.""" 

17 

18 def filter_by_id(self, id_: UserInvitationIdentifier) -> "UserInvitationQuery": 

19 """Add a filter on the user invitation for id. 

20 

21 Args: 

22 id_: An id of a user invitation. 

23 

24 Returns: 

25 The active query 

26 """ 

27 raise NotImplementedError 

28 

29 def filter_by_uuid(self, uuid: UniqueId) -> "UserInvitationQuery": 

30 """Add a filter on the user invitation for the unique id. 

31 

32 Args: 

33 uuid: A unique id of a user invitation. 

34 

35 Returns: 

36 The active query 

37 """ 

38 raise NotImplementedError 

39 

40 def filter_by_email(self, email: EmailAddress) -> "UserInvitationQuery": 

41 """Add a filter on the user invitation for the email address. 

42 

43 Args: 

44 email: An email address. 

45 

46 Returns: 

47 The active query 

48 """ 

49 raise NotImplementedError 

50 

51 def filter_active(self) -> "UserInvitationQuery": 

52 """Add a filter to only return the active invitations at the given time. 

53 

54 Returns: 

55 The active query 

56 """ 

57 raise NotImplementedError 

58 

59 def filter_not_expired(self, timestamp: Timestamp) -> "UserInvitationQuery": 

60 """Add a filter to only return not expired invitations. 

61 

62 Returns: 

63 The active query. 

64 """ 

65 raise NotImplementedError 

66 

67 def filter_not_confirmed(self) -> "UserInvitationQuery": 

68 """Add a filter to only return not confirmed invitations. 

69 

70 Returns: 

71 The active query. 

72 """ 

73 raise NotImplementedError