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

vrchatapi/models/limited_user_search.py

@@ -0,0 +1,395 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from typing_extensions import Annotated
+from vrchatapi.models.developer_type import DeveloperType
+from vrchatapi.models.user_status import UserStatus
+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 LimitedUserSearch(BaseModel):
+    """
+    User object received when searching
+
+    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
+    banner_color: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("bannerColor", "banner_color"), serialization_alias="bannerColor")
+    banner_type: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("bannerType", "banner_type"), serialization_alias="bannerType")
+    banner_url: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("bannerUrl", "banner_url"), serialization_alias="bannerUrl")
+    bio: Optional[StrictStr] = None
+    bio_links: Optional[List[StrictStr]] = Field(default=None, validation_alias=AliasChoices("bioLinks", "bio_links"), serialization_alias="bioLinks", description=" ")
+    current_avatar_image_url: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("currentAvatarImageUrl", "current_avatar_image_url"), serialization_alias="currentAvatarImageUrl", description="When profilePicOverride is not empty, use it instead.", json_schema_extra={"examples": ["https://api.vrchat.cloud/api/1/file/file_ae46d521-7281-4b38-b365-804b32a1d6a7/1/file"]})
+    current_avatar_tags: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = Field(default=None, validation_alias=AliasChoices("currentAvatarTags", "current_avatar_tags"), serialization_alias="currentAvatarTags")
+    current_avatar_thumbnail_image_url: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("currentAvatarThumbnailImageUrl", "current_avatar_thumbnail_image_url"), serialization_alias="currentAvatarThumbnailImageUrl", description="When profilePicOverride is not empty, use it instead.", json_schema_extra={"examples": ["https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256"]})
+    developer_type: Optional[DeveloperType] = Field(default=None, validation_alias=AliasChoices("developerType", "developer_type"), serialization_alias="developerType")
+    display_name: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("displayName", "display_name"), serialization_alias="displayName")
+    icon_frame: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("iconFrame", "icon_frame"), serialization_alias="iconFrame")
+    icon_url: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("iconUrl", "icon_url"), serialization_alias="iconUrl")
+    id: Optional[StrictStr] = Field(default=None, description="A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.", json_schema_extra={"examples": ["usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"]})
+    is_friend: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("isFriend", "is_friend"), serialization_alias="isFriend")
+    last_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"]})
+    nameplate_effect: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("nameplateEffect", "nameplate_effect"), serialization_alias="nameplateEffect")
+    profile_effect: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("profileEffect", "profile_effect"), serialization_alias="profileEffect")
+    profile_pic_override: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("profilePicOverride", "profile_pic_override"), serialization_alias="profilePicOverride")
+    pronouns: Optional[StrictStr] = None
+    status: Optional[UserStatus] = None
+    status_description: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("statusDescription", "status_description"), serialization_alias="statusDescription")
+    tags: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = Field(default=None, description="<- Always empty.")
+    user_icon: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("userIcon", "user_icon"), serialization_alias="userIcon")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "banner_color": "str",
+        "banner_type": "str",
+        "banner_url": "str",
+        "bio": "str",
+        "bio_links": "List[str]",
+        "current_avatar_image_url": "str",
+        "current_avatar_tags": "List[str]",
+        "current_avatar_thumbnail_image_url": "str",
+        "developer_type": "DeveloperType",
+        "display_name": "str",
+        "icon_frame": "str",
+        "icon_url": "str",
+        "id": "str",
+        "is_friend": "bool",
+        "last_platform": "str",
+        "nameplate_effect": "str",
+        "profile_effect": "str",
+        "profile_pic_override": "str",
+        "pronouns": "str",
+        "status": "UserStatus",
+        "status_description": "str",
+        "tags": "List[str]",
+        "user_icon": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "banner_color": "bannerColor",
+        "banner_type": "bannerType",
+        "banner_url": "bannerUrl",
+        "bio": "bio",
+        "bio_links": "bioLinks",
+        "current_avatar_image_url": "currentAvatarImageUrl",
+        "current_avatar_tags": "currentAvatarTags",
+        "current_avatar_thumbnail_image_url": "currentAvatarThumbnailImageUrl",
+        "developer_type": "developerType",
+        "display_name": "displayName",
+        "icon_frame": "iconFrame",
+        "icon_url": "iconUrl",
+        "id": "id",
+        "is_friend": "isFriend",
+        "last_platform": "last_platform",
+        "nameplate_effect": "nameplateEffect",
+        "profile_effect": "profileEffect",
+        "profile_pic_override": "profilePicOverride",
+        "pronouns": "pronouns",
+        "status": "status",
+        "status_description": "statusDescription",
+        "tags": "tags",
+        "user_icon": "userIcon"
+    }
+    __properties: ClassVar[List[str]] = ["bannerColor", "bannerType", "bannerUrl", "bio", "bioLinks", "currentAvatarImageUrl", "currentAvatarTags", "currentAvatarThumbnailImageUrl", "developerType", "displayName", "iconFrame", "iconUrl", "id", "isFriend", "last_platform", "nameplateEffect", "profileEffect", "profilePicOverride", "pronouns", "status", "statusDescription", "tags", "userIcon"]
+
+    @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 "bannerColor" not in obj and "banner_color" in obj:
+            obj["bannerColor"] = obj["banner_color"]
+        obj.pop("banner_color", None)
+        if "bannerType" not in obj and "banner_type" in obj:
+            obj["bannerType"] = obj["banner_type"]
+        obj.pop("banner_type", None)
+        if "bannerUrl" not in obj and "banner_url" in obj:
+            obj["bannerUrl"] = obj["banner_url"]
+        obj.pop("banner_url", None)
+        if "bioLinks" not in obj and "bio_links" in obj:
+            obj["bioLinks"] = obj["bio_links"]
+        obj.pop("bio_links", None)
+        if "currentAvatarImageUrl" not in obj and "current_avatar_image_url" in obj:
+            obj["currentAvatarImageUrl"] = obj["current_avatar_image_url"]
+        obj.pop("current_avatar_image_url", None)
+        if "currentAvatarTags" not in obj and "current_avatar_tags" in obj:
+            obj["currentAvatarTags"] = obj["current_avatar_tags"]
+        obj.pop("current_avatar_tags", None)
+        if "currentAvatarThumbnailImageUrl" not in obj and "current_avatar_thumbnail_image_url" in obj:
+            obj["currentAvatarThumbnailImageUrl"] = obj["current_avatar_thumbnail_image_url"]
+        obj.pop("current_avatar_thumbnail_image_url", None)
+        if "developerType" not in obj and "developer_type" in obj:
+            obj["developerType"] = obj["developer_type"]
+        obj.pop("developer_type", None)
+        if "displayName" not in obj and "display_name" in obj:
+            obj["displayName"] = obj["display_name"]
+        obj.pop("display_name", None)
+        if "iconFrame" not in obj and "icon_frame" in obj:
+            obj["iconFrame"] = obj["icon_frame"]
+        obj.pop("icon_frame", None)
+        if "iconUrl" not in obj and "icon_url" in obj:
+            obj["iconUrl"] = obj["icon_url"]
+        obj.pop("icon_url", None)
+        if "isFriend" not in obj and "is_friend" in obj:
+            obj["isFriend"] = obj["is_friend"]
+        obj.pop("is_friend", None)
+        if "nameplateEffect" not in obj and "nameplate_effect" in obj:
+            obj["nameplateEffect"] = obj["nameplate_effect"]
+        obj.pop("nameplate_effect", None)
+        if "profileEffect" not in obj and "profile_effect" in obj:
+            obj["profileEffect"] = obj["profile_effect"]
+        obj.pop("profile_effect", None)
+        if "profilePicOverride" not in obj and "profile_pic_override" in obj:
+            obj["profilePicOverride"] = obj["profile_pic_override"]
+        obj.pop("profile_pic_override", None)
+        if "statusDescription" not in obj and "status_description" in obj:
+            obj["statusDescription"] = obj["status_description"]
+        obj.pop("status_description", None)
+        if "userIcon" not in obj and "user_icon" in obj:
+            obj["userIcon"] = obj["user_icon"]
+        obj.pop("user_icon", 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, LimitedUserSearch):
+            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, LimitedUserSearch):
+            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 LimitedUserSearch 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 {
+            ("bannerColor" if serialize else "banner_color"): _to_legacy_value(getattr(self, "banner_color", None), serialize),
+            ("bannerType" if serialize else "banner_type"): _to_legacy_value(getattr(self, "banner_type", None), serialize),
+            ("bannerUrl" if serialize else "banner_url"): _to_legacy_value(getattr(self, "banner_url", None), serialize),
+            ("bio" if serialize else "bio"): _to_legacy_value(getattr(self, "bio", None), serialize),
+            ("bioLinks" if serialize else "bio_links"): _to_legacy_value(getattr(self, "bio_links", None), serialize),
+            ("currentAvatarImageUrl" if serialize else "current_avatar_image_url"): _to_legacy_value(getattr(self, "current_avatar_image_url", None), serialize),
+            ("currentAvatarTags" if serialize else "current_avatar_tags"): _to_legacy_value(getattr(self, "current_avatar_tags", None), serialize),
+            ("currentAvatarThumbnailImageUrl" if serialize else "current_avatar_thumbnail_image_url"): _to_legacy_value(getattr(self, "current_avatar_thumbnail_image_url", None), serialize),
+            ("developerType" if serialize else "developer_type"): _to_legacy_value(getattr(self, "developer_type", None), serialize),
+            ("displayName" if serialize else "display_name"): _to_legacy_value(getattr(self, "display_name", None), serialize),
+            ("iconFrame" if serialize else "icon_frame"): _to_legacy_value(getattr(self, "icon_frame", None), serialize),
+            ("iconUrl" if serialize else "icon_url"): _to_legacy_value(getattr(self, "icon_url", None), serialize),
+            ("id" if serialize else "id"): _to_legacy_value(getattr(self, "id", None), serialize),
+            ("isFriend" if serialize else "is_friend"): _to_legacy_value(getattr(self, "is_friend", None), serialize),
+            ("last_platform" if serialize else "last_platform"): _to_legacy_value(getattr(self, "last_platform", None), serialize),
+            ("nameplateEffect" if serialize else "nameplate_effect"): _to_legacy_value(getattr(self, "nameplate_effect", None), serialize),
+            ("profileEffect" if serialize else "profile_effect"): _to_legacy_value(getattr(self, "profile_effect", None), serialize),
+            ("profilePicOverride" if serialize else "profile_pic_override"): _to_legacy_value(getattr(self, "profile_pic_override", None), serialize),
+            ("pronouns" if serialize else "pronouns"): _to_legacy_value(getattr(self, "pronouns", None), serialize),
+            ("status" if serialize else "status"): _to_legacy_value(getattr(self, "status", None), serialize),
+            ("statusDescription" if serialize else "status_description"): _to_legacy_value(getattr(self, "status_description", None), serialize),
+            ("tags" if serialize else "tags"): _to_legacy_value(getattr(self, "tags", None), serialize),
+            ("userIcon" if serialize else "user_icon"): _to_legacy_value(getattr(self, "user_icon", 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 LimitedUserSearch 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({
+            "bannerColor": obj.get("bannerColor"),
+            "bannerType": obj.get("bannerType"),
+            "bannerUrl": obj.get("bannerUrl"),
+            "bio": obj.get("bio"),
+            "bioLinks": obj.get("bioLinks"),
+            "currentAvatarImageUrl": obj.get("currentAvatarImageUrl"),
+            "currentAvatarTags": obj.get("currentAvatarTags"),
+            "currentAvatarThumbnailImageUrl": obj.get("currentAvatarThumbnailImageUrl"),
+            "developerType": obj.get("developerType") if obj.get("developerType") is not None else DeveloperType.NONE,
+            "displayName": obj.get("displayName"),
+            "iconFrame": obj.get("iconFrame"),
+            "iconUrl": obj.get("iconUrl"),
+            "id": obj.get("id"),
+            "isFriend": obj.get("isFriend"),
+            "last_platform": obj.get("last_platform"),
+            "nameplateEffect": obj.get("nameplateEffect"),
+            "profileEffect": obj.get("profileEffect"),
+            "profilePicOverride": obj.get("profilePicOverride"),
+            "pronouns": obj.get("pronouns"),
+            "status": obj.get("status") if obj.get("status") is not None else UserStatus.OFFLINE,
+            "statusDescription": obj.get("statusDescription"),
+            "tags": obj.get("tags"),
+            "userIcon": obj.get("userIcon")
+        })
+        return _obj
+
+