vrchatapi-async 1.20.8.dev1__py3-none-any.whl

vrchatapi/models/private_profile_activity.py

@@ -0,0 +1,292 @@
+# coding: utf-8
+
+"""
+    VRChat API Documentation
+
+
+    The version of the OpenAPI document: 1.20.8
+    Contact: vrchatapi.lpv0t@aries.fyi
+    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 collections.abc import Mapping as _Mapping
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from vrchatapi.models.user_state import UserState
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+_OPENAPI_GENERATOR_TO_DICT = "_openapi_generator_to_dict"
+
+
+def _get_openapi_to_dict(value: Any) -> Any:
+    # Reciprocal function references preserve inherited generated methods
+    # without reserving model member names. Checking both directions also
+    # rejects overrides whose decorators copy function attributes.
+    to_dict = getattr(value, "to_dict", None)
+    type_to_dict = getattr(type(value), "to_dict", None)
+    if (
+        not callable(to_dict)
+        or getattr(to_dict, "__func__", None) is not type_to_dict
+    ):
+        return None
+
+    openapi_to_dict = getattr(
+        type_to_dict, _OPENAPI_GENERATOR_TO_DICT, None
+    )
+    if (
+        not callable(openapi_to_dict)
+        or getattr(
+            openapi_to_dict,
+            _OPENAPI_GENERATOR_TO_DICT,
+            None,
+        ) is not type_to_dict
+    ):
+        return None
+    return openapi_to_dict
+
+
+def _to_legacy_item(value: Any, serialize: bool) -> Any:
+    to_dict = getattr(value, "to_dict", None)
+    if _get_openapi_to_dict(value) is not None and callable(to_dict):
+        return to_dict(serialize=serialize)
+    if callable(to_dict):
+        return to_dict()
+    return value
+
+
+def _to_legacy_value(value: Any, serialize: bool) -> Any:
+    # python-legacy converted only immediate list elements or dictionary values:
+    # https://github.com/OpenAPITools/openapi-generator/blob/c84b949df1a9ec04ba75989cb49b45c940c2f694/modules/openapi-generator/src/main/resources/python-legacy/model.mustache#L203-L231
+    if isinstance(value, list):
+        return [_to_legacy_item(item, serialize) for item in value]
+    if isinstance(value, dict):
+        return {
+            key: _to_legacy_item(item, serialize)
+            for key, item in value.items()
+        }
+    return _to_legacy_item(value, serialize)
+
+
+def _to_openapi_value(value: Any) -> Any:
+    if isinstance(value, list):
+        return [_to_openapi_value(item) for item in value]
+    if isinstance(value, dict):
+        return {key: _to_openapi_value(item) for key, item in value.items()}
+
+    to_openapi_dict = _get_openapi_to_dict(value)
+    if to_openapi_dict is not None:
+        return to_openapi_dict(value)
+
+    to_dict = getattr(value, "to_dict", None)
+    if callable(to_dict):
+        return to_dict()
+    return value
+
+
+class PrivateProfileActivity(BaseModel):
+    """
+    PrivateProfileActivity
+
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """ # noqa: E501
+    instance_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("instanceId", "instance_id"), serialization_alias="instanceId", description="InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance.", json_schema_extra={"examples": ["12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)"]})
+    last_activity: Optional[StrictStr] = Field(default=None, description="Either a date-time or an empty string.")
+    last_login: Optional[StrictStr] = Field(default=None, description="Either a date-time or an empty string.")
+    location: Optional[StrictStr] = Field(default=None, description="Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list.", json_schema_extra={"examples": ["wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)"]})
+    platform: Optional[StrictStr] = Field(default=None, description="This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`.", json_schema_extra={"examples": ["standalonewindows"]})
+    state: Optional[UserState] = UserState.OFFLINE
+    traveling_to_instance: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("travelingToInstance", "traveling_to_instance"), serialization_alias="travelingToInstance")
+    traveling_to_location: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("travelingToLocation", "traveling_to_location"), serialization_alias="travelingToLocation")
+    traveling_to_world: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("travelingToWorld", "traveling_to_world"), serialization_alias="travelingToWorld")
+    world_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("worldId", "world_id"), serialization_alias="worldId", description="WorldID be \"offline\" on User profiles if you are not friends with that user.", json_schema_extra={"examples": ["wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd"]})
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "instance_id": "str",
+        "last_activity": "str",
+        "last_login": "str",
+        "location": "str",
+        "platform": "str",
+        "state": "UserState",
+        "traveling_to_instance": "str",
+        "traveling_to_location": "str",
+        "traveling_to_world": "str",
+        "world_id": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "instance_id": "instanceId",
+        "last_activity": "last_activity",
+        "last_login": "last_login",
+        "location": "location",
+        "platform": "platform",
+        "state": "state",
+        "traveling_to_instance": "travelingToInstance",
+        "traveling_to_location": "travelingToLocation",
+        "traveling_to_world": "travelingToWorld",
+        "world_id": "worldId"
+    }
+    __properties: ClassVar[List[str]] = ["instanceId", "last_activity", "last_login", "location", "platform", "state", "travelingToInstance", "travelingToLocation", "travelingToWorld", "worldId"]
+
+    @classmethod
+    def __preprocess_input_names(
+        cls,
+        obj: Any,
+        remove_hidden_storage_names: bool = True,
+    ) -> Any:
+        if not isinstance(obj, _Mapping):
+            return obj
+        obj = dict(obj)
+        if "instanceId" not in obj and "instance_id" in obj:
+            obj["instanceId"] = obj["instance_id"]
+        obj.pop("instance_id", None)
+        if "travelingToInstance" not in obj and "traveling_to_instance" in obj:
+            obj["travelingToInstance"] = obj["traveling_to_instance"]
+        obj.pop("traveling_to_instance", None)
+        if "travelingToLocation" not in obj and "traveling_to_location" in obj:
+            obj["travelingToLocation"] = obj["traveling_to_location"]
+        obj.pop("traveling_to_location", None)
+        if "travelingToWorld" not in obj and "traveling_to_world" in obj:
+            obj["travelingToWorld"] = obj["traveling_to_world"]
+        obj.pop("traveling_to_world", None)
+        if "worldId" not in obj and "world_id" in obj:
+            obj["worldId"] = obj["world_id"]
+        obj.pop("world_id", None)
+        return obj
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        extra="forbid",
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self) -> str:
+        """For print and pprint"""
+        return self.to_str()
+
+    def __eq__(self, other: object) -> bool:
+        """Returns true if both objects are equal"""
+        if not isinstance(other, PrivateProfileActivity):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other: object) -> bool:
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, PrivateProfileActivity):
+            return True
+
+        return not (self == other)
+
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        to_openapi_dict = _get_openapi_to_dict(self)
+        if to_openapi_dict is not None:
+            return json.dumps(to_jsonable_python(to_openapi_dict(self)))
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PrivateProfileActivity from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self, serialize: bool = False) -> Dict[str, Any]:
+        """Return all declared model fields using public or wire names."""
+        return {
+            ("instanceId" if serialize else "instance_id"): _to_legacy_value(getattr(self, "instance_id", None), serialize),
+            ("last_activity" if serialize else "last_activity"): _to_legacy_value(getattr(self, "last_activity", None), serialize),
+            ("last_login" if serialize else "last_login"): _to_legacy_value(getattr(self, "last_login", None), serialize),
+            ("location" if serialize else "location"): _to_legacy_value(getattr(self, "location", None), serialize),
+            ("platform" if serialize else "platform"): _to_legacy_value(getattr(self, "platform", None), serialize),
+            ("state" if serialize else "state"): _to_legacy_value(getattr(self, "state", None), serialize),
+            ("travelingToInstance" if serialize else "traveling_to_instance"): _to_legacy_value(getattr(self, "traveling_to_instance", None), serialize),
+            ("travelingToLocation" if serialize else "traveling_to_location"): _to_legacy_value(getattr(self, "traveling_to_location", None), serialize),
+            ("travelingToWorld" if serialize else "traveling_to_world"): _to_legacy_value(getattr(self, "traveling_to_world", None), serialize),
+            ("worldId" if serialize else "world_id"): _to_legacy_value(getattr(self, "world_id", None), serialize),
+        }
+
+    def __openapi_generator_modern_projection(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
+
+    setattr(
+        to_dict,
+        _OPENAPI_GENERATOR_TO_DICT,
+        __openapi_generator_modern_projection,
+    )
+    setattr(
+        __openapi_generator_modern_projection,
+        _OPENAPI_GENERATOR_TO_DICT,
+        to_dict,
+    )
+    del __openapi_generator_modern_projection
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PrivateProfileActivity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj = _cast(
+            Dict[str, Any],
+            cls.__preprocess_input_names(
+                obj,
+                remove_hidden_storage_names=True,
+            ),
+        )
+
+        _obj = cls.model_validate({
+            "instanceId": obj.get("instanceId"),
+            "last_activity": obj.get("last_activity"),
+            "last_login": obj.get("last_login"),
+            "location": obj.get("location"),
+            "platform": obj.get("platform"),
+            "state": obj.get("state") if obj.get("state") is not None else UserState.OFFLINE,
+            "travelingToInstance": obj.get("travelingToInstance"),
+            "travelingToLocation": obj.get("travelingToLocation"),
+            "travelingToWorld": obj.get("travelingToWorld"),
+            "worldId": obj.get("worldId")
+        })
+        return _obj
+
+