twitter-openapi-python-generated 0.0.14__py3-none-any.whl → 0.0.16__py3-none-any.whl

twitter_openapi_python_generated/api_client.py

@@ -23,7 +23,8 @@ import re
 import tempfile
 
 from urllib.parse import quote
-from typing import Tuple, Optional, List, Dict
+from typing import Tuple, Optional, List, Dict, Union
+from pydantic import SecretStr
 
 from twitter_openapi_python_generated.configuration import Configuration
 from twitter_openapi_python_generated.api_response import ApiResponse, T as ApiResponseT
@@ -88,7 +89,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.0.14/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.16/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):
@@ -208,7 +209,8 @@ class ApiClient:
                 post_params,
                 collection_formats
             )
-            post_params.extend(self.files_parameters(files))
+            if files:
+                post_params.extend(self.files_parameters(files))
 
         # auth setting
         self.update_params_for_auth(
@@ -313,7 +315,10 @@ class ApiClient:
                     match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
                 encoding = match.group(1) if match else "utf-8"
                 response_text = response_data.data.decode(encoding)
-                return_data = self.deserialize(response_text, response_type)
+                if response_type in ["bytearray", "str"]:
+                    return_data = self.__deserialize_primitive(response_text, response_type)
+                else:
+                    return_data = self.deserialize(response_text, response_type)
         finally:
             if not 200 <= response_data.status <= 299:
                 raise ApiException.from_response(
@@ -333,6 +338,7 @@ class ApiClient:
         """Builds a JSON POST object.
 
         If obj is None, return None.
+        If obj is SecretStr, return obj.get_secret_value()
         If obj is str, int, long, float, bool, return directly.
         If obj is datetime.datetime, datetime.date
             convert to string in iso8601 format.
@@ -345,6 +351,10 @@ class ApiClient:
         """
         if obj is None:
             return None
+        elif isinstance(obj, Enum):
+            return obj.value
+        elif isinstance(obj, SecretStr):
+            return obj.get_secret_value()
         elif isinstance(obj, self.PRIMITIVE_TYPES):
             return obj
         elif isinstance(obj, list):
@@ -366,7 +376,10 @@ class ApiClient:
             # and attributes which value is not None.
             # Convert attribute name to json key in
             # model definition for request.
-            obj_dict = obj.to_dict()
+            if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')):
+                obj_dict = obj.to_dict()
+            else:
+                obj_dict = obj.__dict__
 
         return {
             key: self.sanitize_for_serialization(val)
@@ -505,31 +518,30 @@ class ApiClient:
 
         return "&".join(["=".join(map(str, item)) for item in new_params])
 
-    def files_parameters(self, files=None):
+    def files_parameters(self, files: Dict[str, Union[str, bytes]]):
         """Builds form parameters.
 
         :param files: File parameters.
         :return: Form parameters with files.
         """
         params = []
-
-        if files:
-            for k, v in files.items():
-                if not v:
-                    continue
-                file_names = v if type(v) is list else [v]
-                for n in file_names:
-                    with open(n, 'rb') as f:
-                        filename = os.path.basename(f.name)
-                        filedata = f.read()
-                        mimetype = (
-                            mimetypes.guess_type(filename)[0]
-                            or 'application/octet-stream'
-                        )
-                        params.append(
-                            tuple([k, tuple([filename, filedata, mimetype])])
-                        )
-
+        for k, v in files.items():
+            if isinstance(v, str):
+                with open(v, 'rb') as f:
+                    filename = os.path.basename(f.name)
+                    filedata = f.read()
+            elif isinstance(v, bytes):
+                filename = k
+                filedata = v
+            else:
+                raise ValueError("Unsupported file value")
+            mimetype = (
+                mimetypes.guess_type(filename)[0]
+                or 'application/octet-stream'
+            )
+            params.append(
+                tuple([k, tuple([filename, filedata, mimetype])])
+            )
         return params
 
     def select_header_accept(self, accepts: List[str]) -> Optional[str]:

twitter_openapi_python_generated/configuration.py

@@ -432,15 +432,6 @@ conf = twitter_openapi_python_generated.Configuration(
                 'key': 'Authorization',
                 'value': 'Bearer ' + self.access_token
             }
-        if 'CacheControl' in self.api_key:
-            auth['CacheControl'] = {
-                'type': 'api_key',
-                'in': 'header',
-                'key': 'Cache-Control',
-                'value': self.get_api_key_with_prefix(
-                    'CacheControl',
-                ),
-            }
         if 'ClientLanguage' in self.api_key:
             auth['ClientLanguage'] = {
                 'type': 'api_key',
@@ -486,13 +477,22 @@ conf = twitter_openapi_python_generated.Configuration(
                     'GuestToken',
                 ),
             }
-        if 'Pragma' in self.api_key:
-            auth['Pragma'] = {
+        if 'Priority' in self.api_key:
+            auth['Priority'] = {
+                'type': 'api_key',
+                'in': 'header',
+                'key': 'Priority',
+                'value': self.get_api_key_with_prefix(
+                    'Priority',
+                ),
+            }
+        if 'Referer' in self.api_key:
+            auth['Referer'] = {
                 'type': 'api_key',
                 'in': 'header',
-                'key': 'Pragma',
+                'key': 'Referer',
                 'value': self.get_api_key_with_prefix(
-                    'Pragma',
+                    'Referer',
                 ),
             }
         if 'SecChUa' in self.api_key:
@@ -569,7 +569,7 @@ conf = twitter_openapi_python_generated.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.0.1\n"\
-               "SDK Package Version: 0.0.14".\
+               "SDK Package Version: 0.0.16".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

twitter_openapi_python_generated/models/__init__.py

@@ -18,6 +18,17 @@
 from twitter_openapi_python_generated.models.additional_media_info import AdditionalMediaInfo
 from twitter_openapi_python_generated.models.additional_media_info_call_to_actions import AdditionalMediaInfoCallToActions
 from twitter_openapi_python_generated.models.additional_media_info_call_to_actions_url import AdditionalMediaInfoCallToActionsUrl
+from twitter_openapi_python_generated.models.allow_download_status import AllowDownloadStatus
+from twitter_openapi_python_generated.models.article import Article
+from twitter_openapi_python_generated.models.article_cover_media import ArticleCoverMedia
+from twitter_openapi_python_generated.models.article_cover_media_color_info import ArticleCoverMediaColorInfo
+from twitter_openapi_python_generated.models.article_cover_media_color_info_palette import ArticleCoverMediaColorInfoPalette
+from twitter_openapi_python_generated.models.article_cover_media_color_info_palette_rgb import ArticleCoverMediaColorInfoPaletteRGB
+from twitter_openapi_python_generated.models.article_cover_media_info import ArticleCoverMediaInfo
+from twitter_openapi_python_generated.models.article_lifecycle_state import ArticleLifecycleState
+from twitter_openapi_python_generated.models.article_metadata import ArticleMetadata
+from twitter_openapi_python_generated.models.article_result import ArticleResult
+from twitter_openapi_python_generated.models.article_results import ArticleResults
 from twitter_openapi_python_generated.models.author_community_relationship import AuthorCommunityRelationship
 from twitter_openapi_python_generated.models.birdwatch_entity import BirdwatchEntity
 from twitter_openapi_python_generated.models.birdwatch_entity_ref import BirdwatchEntityRef
@@ -48,6 +59,8 @@ from twitter_openapi_python_generated.models.content_entry_type import ContentEn
 from twitter_openapi_python_generated.models.content_item_type import ContentItemType
 from twitter_openapi_python_generated.models.content_union import ContentUnion
 from twitter_openapi_python_generated.models.cover_cta import CoverCta
+from twitter_openapi_python_generated.models.create_bookmark_response import CreateBookmarkResponse
+from twitter_openapi_python_generated.models.create_bookmark_response_data import CreateBookmarkResponseData
 from twitter_openapi_python_generated.models.create_retweet import CreateRetweet
 from twitter_openapi_python_generated.models.create_retweet_response import CreateRetweetResponse
 from twitter_openapi_python_generated.models.create_retweet_response_data import CreateRetweetResponseData
@@ -58,6 +71,8 @@ from twitter_openapi_python_generated.models.create_tweet_response_data import C
 from twitter_openapi_python_generated.models.create_tweet_response_result import CreateTweetResponseResult
 from twitter_openapi_python_generated.models.cta_client_event_info import CtaClientEventInfo
 from twitter_openapi_python_generated.models.cursor_type import CursorType
+from twitter_openapi_python_generated.models.delete_bookmark_response import DeleteBookmarkResponse
+from twitter_openapi_python_generated.models.delete_bookmark_response_data import DeleteBookmarkResponseData
 from twitter_openapi_python_generated.models.delete_retweet import DeleteRetweet
 from twitter_openapi_python_generated.models.delete_retweet_response import DeleteRetweetResponse
 from twitter_openapi_python_generated.models.delete_retweet_response_data import DeleteRetweetResponseData
@@ -113,11 +128,15 @@ from twitter_openapi_python_generated.models.media import Media
 from twitter_openapi_python_generated.models.media_extended import MediaExtended
 from twitter_openapi_python_generated.models.media_original_info import MediaOriginalInfo
 from twitter_openapi_python_generated.models.media_original_info_focus_rect import MediaOriginalInfoFocusRect
+from twitter_openapi_python_generated.models.media_result import MediaResult
+from twitter_openapi_python_generated.models.media_results import MediaResults
 from twitter_openapi_python_generated.models.media_size import MediaSize
 from twitter_openapi_python_generated.models.media_sizes import MediaSizes
 from twitter_openapi_python_generated.models.media_stats import MediaStats
 from twitter_openapi_python_generated.models.media_video_info import MediaVideoInfo
 from twitter_openapi_python_generated.models.media_video_info_variant import MediaVideoInfoVariant
+from twitter_openapi_python_generated.models.media_visibility_results import MediaVisibilityResults
+from twitter_openapi_python_generated.models.media_visibility_results_blurred_image_interstitial import MediaVisibilityResultsBlurredImageInterstitial
 from twitter_openapi_python_generated.models.module_entry import ModuleEntry
 from twitter_openapi_python_generated.models.module_item import ModuleItem
 from twitter_openapi_python_generated.models.note_tweet import NoteTweet
@@ -130,6 +149,9 @@ from twitter_openapi_python_generated.models.note_tweet_result_rich_text_tag imp
 from twitter_openapi_python_generated.models.one_factor_login_eligibility import OneFactorLoginEligibility
 from twitter_openapi_python_generated.models.other200_response import Other200Response
 from twitter_openapi_python_generated.models.other_response import OtherResponse
+from twitter_openapi_python_generated.models.post_create_bookmark200_response import PostCreateBookmark200Response
+from twitter_openapi_python_generated.models.post_create_bookmark_request import PostCreateBookmarkRequest
+from twitter_openapi_python_generated.models.post_create_bookmark_request_variables import PostCreateBookmarkRequestVariables
 from twitter_openapi_python_generated.models.post_create_retweet200_response import PostCreateRetweet200Response
 from twitter_openapi_python_generated.models.post_create_retweet_request import PostCreateRetweetRequest
 from twitter_openapi_python_generated.models.post_create_retweet_request_variables import PostCreateRetweetRequestVariables
@@ -140,6 +162,8 @@ from twitter_openapi_python_generated.models.post_create_tweet_request_variables
 from twitter_openapi_python_generated.models.post_create_tweet_request_variables_media import PostCreateTweetRequestVariablesMedia
 from twitter_openapi_python_generated.models.post_create_tweet_request_variables_media_media_entities_inner import PostCreateTweetRequestVariablesMediaMediaEntitiesInner
 from twitter_openapi_python_generated.models.post_create_tweet_request_variables_reply import PostCreateTweetRequestVariablesReply
+from twitter_openapi_python_generated.models.post_delete_bookmark200_response import PostDeleteBookmark200Response
+from twitter_openapi_python_generated.models.post_delete_bookmark_request import PostDeleteBookmarkRequest
 from twitter_openapi_python_generated.models.post_delete_retweet200_response import PostDeleteRetweet200Response
 from twitter_openapi_python_generated.models.post_delete_retweet_request import PostDeleteRetweetRequest
 from twitter_openapi_python_generated.models.post_delete_retweet_request_variables import PostDeleteRetweetRequestVariables
@@ -250,6 +274,8 @@ from twitter_openapi_python_generated.models.user_highlights_tweets_result impor
 from twitter_openapi_python_generated.models.user_highlights_tweets_timeline import UserHighlightsTweetsTimeline
 from twitter_openapi_python_generated.models.user_highlights_tweets_user import UserHighlightsTweetsUser
 from twitter_openapi_python_generated.models.user_legacy import UserLegacy
+from twitter_openapi_python_generated.models.user_legacy_extended_profile import UserLegacyExtendedProfile
+from twitter_openapi_python_generated.models.user_legacy_extended_profile_birthdate import UserLegacyExtendedProfileBirthdate
 from twitter_openapi_python_generated.models.user_professional import UserProfessional
 from twitter_openapi_python_generated.models.user_professional_category import UserProfessionalCategory
 from twitter_openapi_python_generated.models.user_response import UserResponse
@@ -259,6 +285,7 @@ from twitter_openapi_python_generated.models.user_result_by_screen_name_legacy i
 from twitter_openapi_python_generated.models.user_result_by_screen_name_result import UserResultByScreenNameResult
 from twitter_openapi_python_generated.models.user_result_core import UserResultCore
 from twitter_openapi_python_generated.models.user_results import UserResults
+from twitter_openapi_python_generated.models.user_tip_jar_settings import UserTipJarSettings
 from twitter_openapi_python_generated.models.user_tweets_data import UserTweetsData
 from twitter_openapi_python_generated.models.user_tweets_response import UserTweetsResponse
 from twitter_openapi_python_generated.models.user_tweets_result import UserTweetsResult

twitter_openapi_python_generated/models/additional_media_info.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from twitter_openapi_python_generated.models.additional_media_info_call_to_actions import AdditionalMediaInfoCallToActions
 from twitter_openapi_python_generated.models.user_result_core import UserResultCore
@@ -37,11 +37,11 @@ class AdditionalMediaInfo(BaseModel):
     title: Optional[StrictStr] = None
     __properties: ClassVar[List[str]] = ["call_to_actions", "description", "embeddable", "monetizable", "source_user", "title"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True,
-        "protected_namespaces": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:

twitter_openapi_python_generated/models/additional_media_info_call_to_actions.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
 from twitter_openapi_python_generated.models.additional_media_info_call_to_actions_url import AdditionalMediaInfoCallToActionsUrl
 from typing import Optional, Set
@@ -32,11 +32,11 @@ class AdditionalMediaInfoCallToActions(BaseModel):
     watch_now: Optional[AdditionalMediaInfoCallToActionsUrl] = None
     __properties: ClassVar[List[str]] = ["visit_site", "watch_now"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True,
-        "protected_namespaces": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:

twitter_openapi_python_generated/models/additional_media_info_call_to_actions_url.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,11 +30,11 @@ class AdditionalMediaInfoCallToActionsUrl(BaseModel):
     url: StrictStr
     __properties: ClassVar[List[str]] = ["url"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True,
-        "protected_namespaces": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:

twitter_openapi_python_generated/models/allow_download_status.py

@@ -0,0 +1,88 @@
+# 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, StrictBool
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AllowDownloadStatus(BaseModel):
+    """
+    AllowDownloadStatus
+    """ # noqa: E501
+    allow_download: StrictBool
+    __properties: ClassVar[List[str]] = ["allow_download"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AllowDownloadStatus 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 AllowDownloadStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "allow_download": obj.get("allow_download")
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/article.py

@@ -0,0 +1,92 @@
+# 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.article_results import ArticleResults
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Article(BaseModel):
+    """
+    Article
+    """ # noqa: E501
+    article_results: ArticleResults
+    __properties: ClassVar[List[str]] = ["article_results"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Article 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 article_results
+        if self.article_results:
+            _dict['article_results'] = self.article_results.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Article from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "article_results": ArticleResults.from_dict(obj["article_results"]) if obj.get("article_results") is not None else None
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/article_cover_media.py

@@ -0,0 +1,106 @@
+# 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, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from twitter_openapi_python_generated.models.article_cover_media_info import ArticleCoverMediaInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ArticleCoverMedia(BaseModel):
+    """
+    ArticleCoverMedia
+    """ # noqa: E501
+    id: StrictStr
+    media_id: Annotated[str, Field(strict=True)]
+    media_info: ArticleCoverMediaInfo
+    media_key: StrictStr
+    __properties: ClassVar[List[str]] = ["id", "media_id", "media_info", "media_key"]
+
+    @field_validator('media_id')
+    def media_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[0-9]+$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9]+$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ArticleCoverMedia 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 media_info
+        if self.media_info:
+            _dict['media_info'] = self.media_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ArticleCoverMedia from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "media_id": obj.get("media_id"),
+            "media_info": ArticleCoverMediaInfo.from_dict(obj["media_info"]) if obj.get("media_info") is not None else None,
+            "media_key": obj.get("media_key")
+        })
+        return _obj
+
+