twitter-openapi-python-generated 0.0.9__py3-none-any.whl → 0.0.11__py3-none-any.whl

twitter_openapi_python_generated/models/social_context_landing_url.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, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from twitter_openapi_python_generated.models.urt_endpoint_options import UrtEndpointOptions
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocialContextLandingUrl(BaseModel):
+    """
+    SocialContextLandingUrl
+    """ # noqa: E501
+    url: Optional[StrictStr] = None
+    url_type: Optional[StrictStr] = Field(default=None, alias="urlType")
+    urt_endpoint_options: Optional[UrtEndpointOptions] = Field(default=None, alias="urtEndpointOptions")
+    __properties: ClassVar[List[str]] = ["url", "urlType", "urtEndpointOptions"]
+
+    @field_validator('url_type')
+    def url_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DeepLink', 'UrtEndpoint']):
+            raise ValueError("must be one of enum values ('DeepLink', 'UrtEndpoint')")
+        return value
+
+    model_config = {
+        "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 SocialContextLandingUrl 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 urt_endpoint_options
+        if self.urt_endpoint_options:
+            _dict['urtEndpointOptions'] = self.urt_endpoint_options.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocialContextLandingUrl from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "urlType": obj.get("urlType"),
+            "urtEndpointOptions": UrtEndpointOptions.from_dict(obj["urtEndpointOptions"]) if obj.get("urtEndpointOptions") is not None else None
+        })
+        return _obj
+
+

twitter_openapi_python_generated/models/social_context_union.py

@@ -0,0 +1,156 @@
+# 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 json
+import pprint
+from pydantic import BaseModel, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from twitter_openapi_python_generated.models.timeline_general_context import TimelineGeneralContext
+from twitter_openapi_python_generated.models.timeline_topic_context import TimelineTopicContext
+from pydantic import StrictStr, Field
+from typing import Union, List, Optional, Dict
+from typing_extensions import Literal, Self
+
+SOCIALCONTEXTUNION_ONE_OF_SCHEMAS = ["TimelineGeneralContext", "TimelineTopicContext"]
+
+class SocialContextUnion(BaseModel):
+    """
+    SocialContextUnion
+    """
+    # data type: TimelineGeneralContext
+    oneof_schema_1_validator: Optional[TimelineGeneralContext] = None
+    # data type: TimelineTopicContext
+    oneof_schema_2_validator: Optional[TimelineTopicContext] = None
+    actual_instance: Optional[Union[TimelineGeneralContext, TimelineTopicContext]] = None
+    one_of_schemas: List[str] = Field(default=Literal["TimelineGeneralContext", "TimelineTopicContext"])
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = SocialContextUnion.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: TimelineGeneralContext
+        if not isinstance(v, TimelineGeneralContext):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TimelineGeneralContext`")
+        else:
+            match += 1
+        # validate data type: TimelineTopicContext
+        if not isinstance(v, TimelineTopicContext):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TimelineTopicContext`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in SocialContextUnion with oneOf schemas: TimelineGeneralContext, TimelineTopicContext. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in SocialContextUnion with oneOf schemas: TimelineGeneralContext, TimelineTopicContext. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # use oneOf discriminator to lookup the data type
+        _data_type = json.loads(json_str).get("type")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `type` in the input.")
+
+        # check if data type is `TimelineGeneralContext`
+        if _data_type == "TimelineGeneralContext":
+            instance.actual_instance = TimelineGeneralContext.from_json(json_str)
+            return instance
+
+        # check if data type is `TimelineTopicContext`
+        if _data_type == "TimelineTopicContext":
+            instance.actual_instance = TimelineTopicContext.from_json(json_str)
+            return instance
+
+        # deserialize data into TimelineGeneralContext
+        try:
+            instance.actual_instance = TimelineGeneralContext.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into TimelineTopicContext
+        try:
+            instance.actual_instance = TimelineTopicContext.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into SocialContextUnion with oneOf schemas: TimelineGeneralContext, TimelineTopicContext. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into SocialContextUnion with oneOf schemas: TimelineGeneralContext, TimelineTopicContext. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], TimelineGeneralContext, TimelineTopicContext]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

twitter_openapi_python_generated/models/social_context_union_type.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class SocialContextUnionType(str, Enum):
+    """
+    SocialContextUnionType
+    """
+
+    """
+    allowed enum values
+    """
+    TIMELINEGENERALCONTEXT = 'TimelineGeneralContext'
+    TIMELINETOPICCONTEXT = 'TimelineTopicContext'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SocialContextUnionType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

twitter_openapi_python_generated/models/super_follows_reply_user_result_data.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, Field
+from typing import Any, ClassVar, Dict, List
+from twitter_openapi_python_generated.models.super_follows_reply_user_result_legacy import SuperFollowsReplyUserResultLegacy
+from twitter_openapi_python_generated.models.type_name import TypeName
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SuperFollowsReplyUserResultData(BaseModel):
+    """
+    SuperFollowsReplyUserResultData
+    """ # noqa: E501
+    typename: TypeName = Field(alias="__typename")
+    legacy: SuperFollowsReplyUserResultLegacy
+    __properties: ClassVar[List[str]] = ["__typename", "legacy"]
+
+    model_config = {
+        "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 SuperFollowsReplyUserResultData 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 legacy
+        if self.legacy:
+            _dict['legacy'] = self.legacy.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SuperFollowsReplyUserResultData 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"),
+            "legacy": SuperFollowsReplyUserResultLegacy.from_dict(obj["legacy"]) if obj.get("legacy") is not None else None
+        })
+        return _obj
+
+

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

twitter_openapi_python_generated/models/text.py

@@ -18,14 +18,11 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import Any, ClassVar, Dict, List
 from pydantic import BaseModel, StrictStr
+from typing import Any, ClassVar, Dict, List
 from twitter_openapi_python_generated.models.text_entity import TextEntity
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class Text(BaseModel):
     """
@@ -52,7 +49,7 @@ class Text(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of Text from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -66,10 +63,12 @@ class Text(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # override the default output from pydantic by calling `to_dict()` of each item in entities (list)
@@ -82,7 +81,7 @@ class Text(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of Text from a dict"""
         if obj is None:
             return None
@@ -91,7 +90,7 @@ class Text(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "entities": [TextEntity.from_dict(_item) for _item in obj.get("entities")] if obj.get("entities") is not None else None,
+            "entities": [TextEntity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
             "text": obj.get("text")
         })
         return _obj

twitter_openapi_python_generated/models/text_entity.py

@@ -18,15 +18,11 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, Field, StrictInt
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictInt
-from pydantic import Field
 from twitter_openapi_python_generated.models.text_entity_ref import TextEntityRef
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class TextEntity(BaseModel):
     """
@@ -54,7 +50,7 @@ class TextEntity(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of TextEntity from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -68,10 +64,12 @@ class TextEntity(BaseModel):
           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={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # override the default output from pydantic by calling `to_dict()` of ref
@@ -80,7 +78,7 @@ class TextEntity(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of TextEntity from a dict"""
         if obj is None:
             return None
@@ -90,7 +88,7 @@ class TextEntity(BaseModel):
 
         _obj = cls.model_validate({
             "fromIndex": obj.get("fromIndex"),
-            "ref": TextEntityRef.from_dict(obj.get("ref")) if obj.get("ref") is not None else None,
+            "ref": TextEntityRef.from_dict(obj["ref"]) if obj.get("ref") is not None else None,
             "toIndex": obj.get("toIndex")
         })
         return _obj