twitter-openapi-python-generated 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

twitter_openapi_python_generated/models/grok_account_jwt.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Twitter OpenAPI
+
+    Twitter OpenAPI(Swagger) specification
+
+    The version of the OpenAPI document: 0.0.1
+    Contact: yuki@yuki0311.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class GrokAccountJwt(BaseModel):
+    """
+    GrokAccountJwt
+    """ # noqa: E501
+    status: StrictStr
+    __properties: ClassVar[List[str]] = ["status"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GrokAccountJwt from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GrokAccountJwt from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status")
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/grok_account_jwt_data.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Twitter OpenAPI
+
+    Twitter OpenAPI(Swagger) specification
+
+    The version of the OpenAPI document: 0.0.1
+    Contact: yuki@yuki0311.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List
+from twitter_openapi_python_generated.models.grok_account_jwt import GrokAccountJwt
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class GrokAccountJwtData(BaseModel):
+    """
+    GrokAccountJwtData
+    """ # noqa: E501
+    grok_account_jwt: GrokAccountJwt
+    __properties: ClassVar[List[str]] = ["grok_account_jwt"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GrokAccountJwtData from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of grok_account_jwt
+        if self.grok_account_jwt:
+            _dict['grok_account_jwt'] = self.grok_account_jwt.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GrokAccountJwtData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "grok_account_jwt": GrokAccountJwt.from_dict(obj["grok_account_jwt"]) if obj.get("grok_account_jwt") is not None else None
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/grok_account_jwt_response.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Twitter OpenAPI
+
+    Twitter OpenAPI(Swagger) specification
+
+    The version of the OpenAPI document: 0.0.1
+    Contact: yuki@yuki0311.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from twitter_openapi_python_generated.models.error_response import ErrorResponse
+from twitter_openapi_python_generated.models.grok_account_jwt_data import GrokAccountJwtData
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class GrokAccountJwtResponse(BaseModel):
+    """
+    GrokAccountJwtResponse
+    """ # noqa: E501
+    data: GrokAccountJwtData
+    errors: Optional[List[ErrorResponse]] = None
+    __properties: ClassVar[List[str]] = ["data", "errors"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of GrokAccountJwtResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
+        _items = []
+        if self.errors:
+            for _item_errors in self.errors:
+                _items.append(_item_errors.to_dict() if _item_errors is not None else None)
+            _dict['errors'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GrokAccountJwtResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": GrokAccountJwtData.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "errors": [ErrorResponse.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/grok_entity_ref.py

@@ -18,8 +18,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic_core import to_jsonable_python
@@ -30,17 +31,29 @@ class GrokEntityRef(BaseModel):
     """ # noqa: E501
     display_url: Optional[StrictStr] = None
     expanded_url: Optional[StrictStr] = None
+    id: Optional[Annotated[str, Field(strict=True)]] = None
+    screen_name: Optional[StrictStr] = None
     text: Optional[StrictStr] = None
     type: StrictStr
     url: Optional[StrictStr] = None
     url_type: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["display_url", "expanded_url", "text", "type", "url", "url_type"]
+    __properties: ClassVar[List[str]] = ["display_url", "expanded_url", "id", "screen_name", "text", "type", "url", "url_type"]
+
+    @field_validator('id', mode="before")
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if isinstance(value, str) and not re.match(r"^[0-9]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9]+$/")
+        return value
 
     @field_validator('type')
     def type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['TimelineUrl', 'TimelineRichTextHashtag']):
-            raise ValueError("must be one of enum values ('TimelineUrl', 'TimelineRichTextHashtag')")
+        if value not in set(['TimelineUrl', 'TimelineRichTextHashtag', 'TimelineRichTextMention']):
+            raise ValueError("must be one of enum values ('TimelineUrl', 'TimelineRichTextHashtag', 'TimelineRichTextMention')")
         return value
 
     @field_validator('url_type')
@@ -106,6 +119,8 @@ class GrokEntityRef(BaseModel):
         _obj = cls.model_validate({
             "display_url": obj.get("display_url"),
             "expanded_url": obj.get("expanded_url"),
+            "id": obj.get("id"),
+            "screen_name": obj.get("screen_name"),
             "text": obj.get("text"),
             "type": obj.get("type"),
             "url": obj.get("url"),

twitter_openapi_python_generated/models/grok_image_annotation.py

@@ -19,7 +19,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, StrictStr
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic_core import to_jsonable_python
@@ -29,7 +29,7 @@ class GrokImageAnnotation(BaseModel):
     GrokImageAnnotation
     """ # noqa: E501
     prompt: StrictStr
-    upsampled_prompt: StrictStr
+    upsampled_prompt: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["prompt", "upsampled_prompt"]
 
     model_config = ConfigDict(

twitter_openapi_python_generated/models/identity_profile_labels_highlighted_label.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Twitter OpenAPI
+
+    Twitter OpenAPI(Swagger) specification
+
+    The version of the OpenAPI document: 0.0.1
+    Contact: yuki@yuki0311.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from twitter_openapi_python_generated.models.user_label import UserLabel
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class IdentityProfileLabelsHighlightedLabel(BaseModel):
+    """
+    IdentityProfileLabelsHighlightedLabel
+    """ # noqa: E501
+    label: Optional[UserLabel] = None
+    __properties: ClassVar[List[str]] = ["label"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of IdentityProfileLabelsHighlightedLabel from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of label
+        if self.label:
+            _dict['label'] = self.label.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IdentityProfileLabelsHighlightedLabel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "label": UserLabel.from_dict(obj["label"]) if obj.get("label") is not None else None
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/limited_action.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from twitter_openapi_python_generated.models.cta_limited_action_prompt import CtaLimitedActionPrompt
 from typing import Optional, Set
@@ -33,6 +33,13 @@ class LimitedAction(BaseModel):
     prompt: Optional[CtaLimitedActionPrompt] = None
     __properties: ClassVar[List[str]] = ["action", "prompt"]
 
+    @field_validator('action')
+    def action_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['Reply', 'Retweet', 'QuoteTweet', 'Like', 'React', 'AddToBookmarks', 'AddToMoment', 'PinToProfile', 'ViewHiddenReplies', 'VoteOnPoll', 'ShowRetweetActionMenu', 'ReplyDownVote', 'SendViaDm', 'ViewPostEngagements', 'CopyLink', 'ShareTweetVia', 'Embed', 'HideCommunityTweet', 'ViewTweetActivity']):
+            raise ValueError("must be one of enum values ('Reply', 'Retweet', 'QuoteTweet', 'Like', 'React', 'AddToBookmarks', 'AddToMoment', 'PinToProfile', 'ViewHiddenReplies', 'VoteOnPoll', 'ShowRetweetActionMenu', 'ReplyDownVote', 'SendViaDm', 'ViewPostEngagements', 'CopyLink', 'ShareTweetVia', 'Embed', 'HideCommunityTweet', 'ViewTweetActivity')")
+        return value
+
     model_config = ConfigDict(
         validate_by_name=True,
         validate_by_alias=True,

twitter_openapi_python_generated/models/limited_action_results_data.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
@@ -31,6 +31,13 @@ class LimitedActionResultsData(BaseModel):
     action: StrictStr
     __properties: ClassVar[List[str]] = ["action"]
 
+    @field_validator('action')
+    def action_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['Reply', 'Retweet', 'QuoteTweet', 'Like', 'React', 'AddToBookmarks', 'AddToMoment', 'PinToProfile', 'ViewHiddenReplies', 'VoteOnPoll', 'ShowRetweetActionMenu', 'ReplyDownVote', 'SendViaDm', 'ViewPostEngagements', 'CopyLink', 'ShareTweetVia', 'Embed', 'HideCommunityTweet', 'ViewTweetActivity']):
+            raise ValueError("must be one of enum values ('Reply', 'Retweet', 'QuoteTweet', 'Like', 'React', 'AddToBookmarks', 'AddToMoment', 'PinToProfile', 'ViewHiddenReplies', 'VoteOnPoll', 'ShowRetweetActionMenu', 'ReplyDownVote', 'SendViaDm', 'ViewPostEngagements', 'CopyLink', 'ShareTweetVia', 'Embed', 'HideCommunityTweet', 'ViewTweetActivity')")
+        return value
+
     model_config = ConfigDict(
         validate_by_name=True,
         validate_by_alias=True,

twitter_openapi_python_generated/models/media_result.py

@@ -30,7 +30,7 @@ class MediaResult(BaseModel):
     MediaResult
     """ # noqa: E501
     grok_image_annotation: Optional[GrokImageAnnotation] = None
-    media_key: StrictStr
+    media_key: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["grok_image_annotation", "media_key"]
 
     model_config = ConfigDict(

twitter_openapi_python_generated/models/module_header.py

@@ -18,8 +18,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from twitter_openapi_python_generated.models.social_context_union import SocialContextUnion
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic_core import to_jsonable_python
@@ -29,16 +30,10 @@ class ModuleHeader(BaseModel):
     ModuleHeader
     """ # noqa: E501
     display_type: StrictStr = Field(alias="displayType")
+    social_context: Optional[SocialContextUnion] = Field(default=None, alias="socialContext")
     sticky: Optional[StrictBool] = None
     text: StrictStr
-    __properties: ClassVar[List[str]] = ["displayType", "sticky", "text"]
-
-    @field_validator('display_type')
-    def display_type_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['Classic']):
-            raise ValueError("must be one of enum values ('Classic')")
-        return value
+    __properties: ClassVar[List[str]] = ["displayType", "socialContext", "sticky", "text"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -79,6 +74,9 @@ class ModuleHeader(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of social_context
+        if self.social_context:
+            _dict['socialContext'] = self.social_context.to_dict()
         return _dict
 
     @classmethod
@@ -92,6 +90,7 @@ class ModuleHeader(BaseModel):
 
         _obj = cls.model_validate({
             "displayType": obj.get("displayType"),
+            "socialContext": SocialContextUnion.from_dict(obj["socialContext"]) if obj.get("socialContext") is not None else None,
             "sticky": obj.get("sticky"),
             "text": obj.get("text")
         })

twitter_openapi_python_generated/models/note_tweet_result_data.py

@@ -32,11 +32,11 @@ class NoteTweetResultData(BaseModel):
     """
     NoteTweetResultData
     """ # noqa: E501
-    entity_set: Entities
+    entity_set: Optional[Entities] = None
     id: Annotated[str, Field(strict=True)]
     media: Optional[NoteTweetResultMedia] = None
     richtext: Optional[NoteTweetResultRichText] = None
-    text: StrictStr
+    text: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["entity_set", "id", "media", "richtext", "text"]
 
     @field_validator('id', mode="before")

twitter_openapi_python_generated/models/session.py

@@ -69,13 +69,6 @@ class Session(BaseModel):
             raise ValueError(r"must validate the regular expression /^[a-z]{2}$/")
         return value
 
-    @field_validator('super_follows_application_status')
-    def super_follows_application_status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['NotStarted']):
-            raise ValueError("must be one of enum values ('NotStarted')")
-        return value
-
     @field_validator('user_id', mode="before")
     def user_id_validate_regular_expression(cls, value):
         """Validates the regular expression"""

twitter_openapi_python_generated/models/sidebar_user_recommendation.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Twitter OpenAPI
+
+    Twitter OpenAPI(Swagger) specification
+
+    The version of the OpenAPI document: 0.0.1
+    Contact: yuki@yuki0311.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from twitter_openapi_python_generated.models.user_results import UserResults
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class SidebarUserRecommendation(BaseModel):
+    """
+    SidebarUserRecommendation
+    """ # noqa: E501
+    token: StrictStr
+    user_results: UserResults
+    __properties: ClassVar[List[str]] = ["token", "user_results"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SidebarUserRecommendation from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of user_results
+        if self.user_results:
+            _dict['user_results'] = self.user_results.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SidebarUserRecommendation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "token": obj.get("token"),
+            "user_results": UserResults.from_dict(obj["user_results"]) if obj.get("user_results") is not None else None
+        })
+        return _obj
+
+