Coverage for functions \ flipdare \ generated \ model \ invite_model.py: 100%

1#!/usr/bin/env python 

2# 

3# Copyright (c) 2026 Flipdare Pty Ltd. All rights reserved. 

4# 

5# This file is part of Flipdare's proprietary software and contains 

6# confidential and copyrighted material. Unauthorised copying, 

7# modification, distribution, or use of this file is strictly 

8# prohibited without prior written permission from Flipdare Pty Ltd. 

9# 

10# This software includes third-party components licensed under MIT, 

11# BSD, and Apache 2.0 licences. See THIRD_PARTY_NOTICES for details. 

12# 

13# NOTE: THIS FILE IS AUTO GENERATED. DO NOT EDIT. 

14# 

15# Generated by codegen_models.py 

16# 

17# Modify 'codegen_models.py' 

18# and re-run the script above to update. 

19# 

20# pragma: no cover 

21from __future__ import annotations 

22from datetime import datetime 

23from google.cloud.firestore_v1.transforms import Sentinel 

24from flipdare.core.firestore_field import FirestoreField 

25from flipdare.util.time_util import FirestoreTime 

26from typing import Any, TypedDict, cast, Unpack 

27from enum import StrEnum 

28from pydantic import Field, ConfigDict, TypeAdapter 

29from flipdare.firestore.core.app_base_model import AppBaseModel 

30from flipdare.generated.shared.model.model_obj_type import ModelObjType 

31 

32 

33class InviteKeys(StrEnum): 

34 ID = "id" 

35 CREATED_AT = "created_at" 

36 UPDATED_AT = "updated_at" 

37 FROM_UID = "from_uid" 

38 FROM_NAME = "from_name" 

39 FROM_EMAIL = "from_email" 

40 TO_UID = "to_uid" 

41 TO_NAME = "to_name" 

42 TO_EMAIL = "to_email" 

43 OBJ_ID = "obj_id" 

44 OBJ_TYPE = "obj_type" 

45 MESSAGE = "message" 

46 VERSION = "version" 

47 PROCESSED = "processed" 

48 ERROR_COUNT = "error_count" 

49 USER_CREATED = "user_created" 

50 EMAIL_SENT = "email_sent" 

51 FRIENDS_CREATED = "friends_created" 

52 SEARCH_INDEXED = "search_indexed" 

53 REMINDER_SENT = "reminder_sent" 

54 

55 

56# !! IMPORTANT !! 

57# !! 

58# !! this should only be used in the database to query. 

59# !! 

60class InviteInternalKeys(StrEnum): 

61 CREATED_AT = "created_at" 

62 UPDATED_AT = "updated_at" 

63 VERSION = "VERSION" 

64 PROCESSED = "INT_P" 

65 ERROR_COUNT = "INT_E" 

66 USER_CREATED = "INT_U_C" 

67 EMAIL_SENT = "INT_E_S" 

68 FRIENDS_CREATED = "INT_F_C" 

69 SEARCH_INDEXED = "INT_I" 

70 REMINDER_SENT = "INT_R_S" 

71 

72 

73class InviteModel(AppBaseModel): 

74 """Represents an invitation sent from one user to another, which can be associated with various objects such as dares, groups, or events.""" 

75 

76 model_config = ConfigDict(populate_by_name=True, arbitrary_types_allowed=True) 

77 

78 id: str | None = Field(None, alias="id") 

79 created_at: FirestoreField = Field( 

80 default_factory=cast("Any", lambda: FirestoreTime.server_timestamp()) 

81 ) 

82 updated_at: FirestoreField = Field( 

83 default_factory=cast("Any", lambda: FirestoreTime.server_timestamp()) 

84 ) 

85 from_uid: str 

86 from_name: str 

87 from_email: str 

88 to_uid: str 

89 to_name: str | None = None 

90 to_email: str 

91 obj_id: str 

92 obj_type: ModelObjType 

93 message: str 

94 # Version (base internal field) 

95 version: int = Field(default=1, alias="VERSION") 

96 # Processed (base internal field) 

97 processed: bool = Field(default=False, alias="INT_P") 

98 # Error Count (base internal field) 

99 error_count: int = Field(default=0, alias="INT_E") 

100 # User Created (internal field) 

101 user_created: bool = Field(default=False, alias="INT_U_C") 

102 # Email Sent (internal field) 

103 email_sent: bool = Field(default=False, alias="INT_E_S") 

104 # Friends Created (internal field) 

105 friends_created: bool = Field(default=False, alias="INT_F_C") 

106 # Search Indexed (internal field) 

107 search_indexed: bool = Field(default=False, alias="INT_I") 

108 # Reminder Sent (internal field) 

109 reminder_sent: bool = Field(default=False, alias="INT_R_S") 

110 

111 @classmethod 

112 def validate_partial(cls, **data: Unpack[InviteDict]) -> dict[str, Any]: 

113 """ 

114 Uses Unpack to give you autocomplete and static warnings 

115 if you pass an invalid key or type in your code. 

116 

117 Returns a dict with Firestore field names (aliases) for use with batch.update(). 

118 """ 

119 result: dict[str, Any] = {} 

120 for k, v in data.items(): 

121 if k in cls.__pydantic_fields__: 

122 field_info = cls.__pydantic_fields__[k] 

123 validated_value = cast( 

124 "Any", 

125 TypeAdapter(field_info.annotation).validate_python(v), 

126 ) 

127 # Use alias if defined, otherwise use field name 

128 output_key = field_info.alias or k 

129 result[output_key] = validated_value 

130 return result 

131 

132 

133INVITE_FIELD_NAMES: list[str] = list(InviteModel.model_fields.keys()) 

134 

135 

136class InviteDict(TypedDict, total=False): 

137 id: str | None 

138 created_at: Sentinel | datetime | str 

139 updated_at: Sentinel | datetime | str 

140 from_uid: str 

141 from_name: str 

142 from_email: str 

143 to_uid: str 

144 to_name: str | None 

145 to_email: str 

146 obj_id: str 

147 obj_type: ModelObjType 

148 message: str 

149 VERSION: int | None 

150 INT_P: bool | None 

151 INT_E: int | None 

152 INT_U_C: bool | None 

153 INT_E_S: bool | None 

154 INT_F_C: bool | None 

155 INT_I: bool | None 

156 INT_R_S: bool | None