twitter-openapi-python-generated 0.0.30__py3-none-any.whl → 0.0.32__py3-none-any.whl

twitter_openapi_python_generated/models/ranked_community_results.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.ranked_community_result import RankedCommunityResult
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RankedCommunityResults(BaseModel):
+    """
+    RankedCommunityResults
+    """ # noqa: E501
+    result: RankedCommunityResult
+    __properties: ClassVar[List[str]] = ["result"]
+
+    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 RankedCommunityResults 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 result
+        if self.result:
+            _dict['result'] = self.result.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RankedCommunityResults from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "result": RankedCommunityResult.from_dict(obj["result"]) if obj.get("result") is not None else None
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/ranked_community_tweet_data.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, Field
+from typing import Any, ClassVar, Dict, List
+from twitter_openapi_python_generated.models.ranked_community_results import RankedCommunityResults
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RankedCommunityTweetData(BaseModel):
+    """
+    RankedCommunityTweetData
+    """ # noqa: E501
+    community_results: RankedCommunityResults = Field(alias="communityResults")
+    __properties: ClassVar[List[str]] = ["communityResults"]
+
+    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 RankedCommunityTweetData 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 community_results
+        if self.community_results:
+            _dict['communityResults'] = self.community_results.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RankedCommunityTweetData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "communityResults": RankedCommunityResults.from_dict(obj["communityResults"]) if obj.get("communityResults") is not None else None
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/rich_message.py

@@ -0,0 +1,90 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RichMessage(BaseModel):
+    """
+    RichMessage
+    """ # noqa: E501
+    rtl: Optional[StrictBool] = None
+    text: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["rtl", "text"]
+
+    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 RichMessage 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 RichMessage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "rtl": obj.get("rtl"),
+            "text": obj.get("text")
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/search_timeline_data.py

@@ -19,7 +19,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict
-from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar, Dict, List
 from twitter_openapi_python_generated.models.search_by_raw_query import SearchByRawQuery
 from typing import Optional, Set
 from typing_extensions import Self
@@ -28,7 +28,7 @@ class SearchTimelineData(BaseModel):
     """
     SearchTimelineData
     """ # noqa: E501
-    search_by_raw_query: Optional[SearchByRawQuery] = None
+    search_by_raw_query: SearchByRawQuery
     __properties: ClassVar[List[str]] = ["search_by_raw_query"]
 
     model_config = ConfigDict(

twitter_openapi_python_generated/models/timeline_add_entry.py

@@ -37,8 +37,8 @@ class TimelineAddEntry(BaseModel):
     @field_validator('entry_id')
     def entry_id_validate_regular_expression(cls, value):
         """Validates the regular expression"""
-        if not re.match(r"^(([a-z]+|[0-9]+|[0-9a-f]+)(-|$))+", value):
-            raise ValueError(r"must validate the regular expression /^(([a-z]+|[0-9]+|[0-9a-f]+)(-|$))+/")
+        if not re.match(r"^(([a-zA-Z]+|[0-9]+|[0-9a-f]+)(-|$))+", value):
+            raise ValueError(r"must validate the regular expression /^(([a-zA-Z]+|[0-9]+|[0-9a-f]+)(-|$))+/")
         return value
 
     @field_validator('sort_index')

twitter_openapi_python_generated/models/timeline_clear_entries_unread_state.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
+from typing import Any, ClassVar, Dict, List
+from twitter_openapi_python_generated.models.instruction_type import InstructionType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TimelineClearEntriesUnreadState(BaseModel):
+    """
+    TimelineClearEntriesUnreadState
+    """ # noqa: E501
+    type: InstructionType
+    __properties: ClassVar[List[str]] = ["type"]
+
+    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 TimelineClearEntriesUnreadState 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 TimelineClearEntriesUnreadState from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type")
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/timeline_general_context.py

@@ -29,11 +29,12 @@ class TimelineGeneralContext(BaseModel):
     """
     TimelineGeneralContext
     """ # noqa: E501
+    context_image_urls: Optional[List[StrictStr]] = Field(default=None, alias="contextImageUrls")
     context_type: Optional[StrictStr] = Field(default=None, alias="contextType")
     landing_url: Optional[SocialContextLandingUrl] = Field(default=None, alias="landingUrl")
     text: Optional[StrictStr] = None
     type: Optional[SocialContextUnionType] = None
-    __properties: ClassVar[List[str]] = ["contextType", "landingUrl", "text", "type"]
+    __properties: ClassVar[List[str]] = ["contextImageUrls", "contextType", "landingUrl", "text", "type"]
 
     @field_validator('context_type')
     def context_type_validate_enum(cls, value):
@@ -41,8 +42,8 @@ class TimelineGeneralContext(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['Follow', 'Pin', 'Like', 'Location', 'Sparkle', 'Conversation', 'List', 'Community']):
-            raise ValueError("must be one of enum values ('Follow', 'Pin', 'Like', 'Location', 'Sparkle', 'Conversation', 'List', 'Community')")
+        if value not in set(['Follow', 'Pin', 'Like', 'Location', 'Sparkle', 'Conversation', 'List', 'Community', 'Facepile']):
+            raise ValueError("must be one of enum values ('Follow', 'Pin', 'Like', 'Location', 'Sparkle', 'Conversation', 'List', 'Community', 'Facepile')")
         return value
 
     model_config = ConfigDict(
@@ -99,6 +100,7 @@ class TimelineGeneralContext(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "contextImageUrls": obj.get("contextImageUrls"),
             "contextType": obj.get("contextType"),
             "landingUrl": SocialContextLandingUrl.from_dict(obj["landingUrl"]) if obj.get("landingUrl") is not None else None,
             "text": obj.get("text"),

twitter_openapi_python_generated/models/timeline_mark_entries_unread_greater_than_sort_index.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, Field, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from twitter_openapi_python_generated.models.instruction_type import InstructionType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TimelineMarkEntriesUnreadGreaterThanSortIndex(BaseModel):
+    """
+    TimelineMarkEntriesUnreadGreaterThanSortIndex
+    """ # noqa: E501
+    sort_index: Optional[Annotated[str, Field(strict=True)]] = None
+    type: InstructionType
+    __properties: ClassVar[List[str]] = ["sort_index", "type"]
+
+    @field_validator('sort_index')
+    def sort_index_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        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 TimelineMarkEntriesUnreadGreaterThanSortIndex 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 TimelineMarkEntriesUnreadGreaterThanSortIndex from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sort_index": obj.get("sort_index"),
+            "type": obj.get("type")
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/timeline_notification.py

@@ -0,0 +1,116 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from twitter_openapi_python_generated.models.content_item_type import ContentItemType
+from twitter_openapi_python_generated.models.notification_template import NotificationTemplate
+from twitter_openapi_python_generated.models.rich_message import RichMessage
+from twitter_openapi_python_generated.models.social_context_landing_url import SocialContextLandingUrl
+from twitter_openapi_python_generated.models.type_name import TypeName
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TimelineNotification(BaseModel):
+    """
+    TimelineNotification
+    """ # noqa: E501
+    typename: TypeName = Field(alias="__typename")
+    id: StrictStr
+    item_type: ContentItemType = Field(alias="itemType")
+    notification_icon: StrictStr
+    notification_url: SocialContextLandingUrl
+    rich_message: RichMessage
+    template: NotificationTemplate
+    timestamp_ms: StrictStr
+    __properties: ClassVar[List[str]] = ["__typename", "id", "itemType", "notification_icon", "notification_url", "rich_message", "template", "timestamp_ms"]
+
+    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 TimelineNotification 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 notification_url
+        if self.notification_url:
+            _dict['notification_url'] = self.notification_url.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rich_message
+        if self.rich_message:
+            _dict['rich_message'] = self.rich_message.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of template
+        if self.template:
+            _dict['template'] = self.template.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TimelineNotification from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "__typename": obj.get("__typename"),
+            "id": obj.get("id"),
+            "itemType": obj.get("itemType"),
+            "notification_icon": obj.get("notification_icon"),
+            "notification_url": SocialContextLandingUrl.from_dict(obj["notification_url"]) if obj.get("notification_url") is not None else None,
+            "rich_message": RichMessage.from_dict(obj["rich_message"]) if obj.get("rich_message") is not None else None,
+            "template": NotificationTemplate.from_dict(obj["template"]) if obj.get("template") is not None else None,
+            "timestamp_ms": obj.get("timestamp_ms")
+        })
+        return _obj
+
+