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

vrchatapi/models/favorited_world.py

@@ -0,0 +1,441 @@
+# 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 datetime import datetime
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from typing_extensions import Annotated
+from vrchatapi.models.instance_content_settings import InstanceContentSettings
+from vrchatapi.models.release_status import ReleaseStatus
+from vrchatapi.models.unity_package import UnityPackage
+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 FavoritedWorld(BaseModel):
+    """
+    
+
+    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
+    author_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("authorId", "author_id"), serialization_alias="authorId", 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"]})
+    author_name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("authorName", "author_name"), serialization_alias="authorName")
+    capacity: Optional[StrictInt] = Field(default=None, json_schema_extra={"examples": [8]})
+    created_at: Optional[datetime] = None
+    default_content_settings: Optional[InstanceContentSettings] = Field(default=None, validation_alias=AliasChoices("defaultContentSettings", "default_content_settings"), serialization_alias="defaultContentSettings")
+    description: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None
+    favorite_group: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("favoriteGroup", "favorite_group"), serialization_alias="favoriteGroup")
+    favorite_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("favoriteId", "favorite_id"), serialization_alias="favoriteId", json_schema_extra={"examples": ["fvrt_9568d189-8776-44a5-a8c8-defc981e44de"]})
+    favorites: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=0, json_schema_extra={"examples": [12024]})
+    featured: Optional[StrictBool] = False
+    heat: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=0, json_schema_extra={"examples": [5]})
+    id: Optional[StrictStr] = Field(default=None, 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"]})
+    image_url: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("imageUrl", "image_url"), serialization_alias="imageUrl")
+    labs_publication_date: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("labsPublicationDate", "labs_publication_date"), serialization_alias="labsPublicationDate", json_schema_extra={"examples": ["none"]})
+    name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None
+    occupants: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, json_schema_extra={"examples": [47]})
+    organization: Optional[Annotated[str, Field(min_length=1, strict=True)]] = 'vrchat'
+    popularity: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=0, json_schema_extra={"examples": [8]})
+    preview_youtube_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("previewYoutubeId", "preview_youtube_id"), serialization_alias="previewYoutubeId")
+    publication_date: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("publicationDate", "publication_date"), serialization_alias="publicationDate", json_schema_extra={"examples": ["none"]})
+    recommended_capacity: Optional[StrictInt] = Field(default=None, validation_alias=AliasChoices("recommendedCapacity", "recommended_capacity"), serialization_alias="recommendedCapacity", json_schema_extra={"examples": [16]})
+    release_status: Optional[ReleaseStatus] = Field(default=None, validation_alias=AliasChoices("releaseStatus", "release_status"), serialization_alias="releaseStatus")
+    tags: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = Field(default=None, description=" ")
+    thumbnail_image_url: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("thumbnailImageUrl", "thumbnail_image_url"), serialization_alias="thumbnailImageUrl")
+    udon_products: Optional[List[StrictStr]] = Field(default=None, validation_alias=AliasChoices("udonProducts", "udon_products"), serialization_alias="udonProducts")
+    unity_packages: Optional[Annotated[List[UnityPackage], Field(min_length=1)]] = Field(default=None, validation_alias=AliasChoices("unityPackages", "unity_packages"), serialization_alias="unityPackages", description=" ")
+    updated_at: Optional[datetime] = None
+    url_list: Optional[List[StrictStr]] = Field(default=None, validation_alias=AliasChoices("urlList", "url_list"), serialization_alias="urlList")
+    version: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    visits: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=0, json_schema_extra={"examples": [9988675]})
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "author_id": "str",
+        "author_name": "str",
+        "capacity": "int",
+        "created_at": "datetime",
+        "default_content_settings": "InstanceContentSettings",
+        "description": "str",
+        "favorite_group": "str",
+        "favorite_id": "str",
+        "favorites": "int",
+        "featured": "bool",
+        "heat": "int",
+        "id": "str",
+        "image_url": "str",
+        "labs_publication_date": "str",
+        "name": "str",
+        "occupants": "int",
+        "organization": "str",
+        "popularity": "int",
+        "preview_youtube_id": "str",
+        "publication_date": "str",
+        "recommended_capacity": "int",
+        "release_status": "ReleaseStatus",
+        "tags": "List[str]",
+        "thumbnail_image_url": "str",
+        "udon_products": "List[str]",
+        "unity_packages": "List[UnityPackage]",
+        "updated_at": "datetime",
+        "url_list": "List[str]",
+        "version": "int",
+        "visits": "int"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "author_id": "authorId",
+        "author_name": "authorName",
+        "capacity": "capacity",
+        "created_at": "created_at",
+        "default_content_settings": "defaultContentSettings",
+        "description": "description",
+        "favorite_group": "favoriteGroup",
+        "favorite_id": "favoriteId",
+        "favorites": "favorites",
+        "featured": "featured",
+        "heat": "heat",
+        "id": "id",
+        "image_url": "imageUrl",
+        "labs_publication_date": "labsPublicationDate",
+        "name": "name",
+        "occupants": "occupants",
+        "organization": "organization",
+        "popularity": "popularity",
+        "preview_youtube_id": "previewYoutubeId",
+        "publication_date": "publicationDate",
+        "recommended_capacity": "recommendedCapacity",
+        "release_status": "releaseStatus",
+        "tags": "tags",
+        "thumbnail_image_url": "thumbnailImageUrl",
+        "udon_products": "udonProducts",
+        "unity_packages": "unityPackages",
+        "updated_at": "updated_at",
+        "url_list": "urlList",
+        "version": "version",
+        "visits": "visits"
+    }
+    __properties: ClassVar[List[str]] = ["authorId", "authorName", "capacity", "created_at", "defaultContentSettings", "description", "favoriteGroup", "favoriteId", "favorites", "featured", "heat", "id", "imageUrl", "labsPublicationDate", "name", "occupants", "organization", "popularity", "previewYoutubeId", "publicationDate", "recommendedCapacity", "releaseStatus", "tags", "thumbnailImageUrl", "udonProducts", "unityPackages", "updated_at", "urlList", "version", "visits"]
+
+    @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 "authorId" not in obj and "author_id" in obj:
+            obj["authorId"] = obj["author_id"]
+        obj.pop("author_id", None)
+        if "authorName" not in obj and "author_name" in obj:
+            obj["authorName"] = obj["author_name"]
+        obj.pop("author_name", None)
+        if "defaultContentSettings" not in obj and "default_content_settings" in obj:
+            obj["defaultContentSettings"] = obj["default_content_settings"]
+        obj.pop("default_content_settings", None)
+        if "favoriteGroup" not in obj and "favorite_group" in obj:
+            obj["favoriteGroup"] = obj["favorite_group"]
+        obj.pop("favorite_group", None)
+        if "favoriteId" not in obj and "favorite_id" in obj:
+            obj["favoriteId"] = obj["favorite_id"]
+        obj.pop("favorite_id", None)
+        if "imageUrl" not in obj and "image_url" in obj:
+            obj["imageUrl"] = obj["image_url"]
+        obj.pop("image_url", None)
+        if "labsPublicationDate" not in obj and "labs_publication_date" in obj:
+            obj["labsPublicationDate"] = obj["labs_publication_date"]
+        obj.pop("labs_publication_date", None)
+        if "previewYoutubeId" not in obj and "preview_youtube_id" in obj:
+            obj["previewYoutubeId"] = obj["preview_youtube_id"]
+        obj.pop("preview_youtube_id", None)
+        if "publicationDate" not in obj and "publication_date" in obj:
+            obj["publicationDate"] = obj["publication_date"]
+        obj.pop("publication_date", None)
+        if "recommendedCapacity" not in obj and "recommended_capacity" in obj:
+            obj["recommendedCapacity"] = obj["recommended_capacity"]
+        obj.pop("recommended_capacity", None)
+        if "releaseStatus" not in obj and "release_status" in obj:
+            obj["releaseStatus"] = obj["release_status"]
+        obj.pop("release_status", None)
+        if "thumbnailImageUrl" not in obj and "thumbnail_image_url" in obj:
+            obj["thumbnailImageUrl"] = obj["thumbnail_image_url"]
+        obj.pop("thumbnail_image_url", None)
+        if "udonProducts" not in obj and "udon_products" in obj:
+            obj["udonProducts"] = obj["udon_products"]
+        obj.pop("udon_products", None)
+        if "unityPackages" not in obj and "unity_packages" in obj:
+            obj["unityPackages"] = obj["unity_packages"]
+        obj.pop("unity_packages", None)
+        if "urlList" not in obj and "url_list" in obj:
+            obj["urlList"] = obj["url_list"]
+        obj.pop("url_list", 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, FavoritedWorld):
+            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, FavoritedWorld):
+            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 FavoritedWorld 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 {
+            ("authorId" if serialize else "author_id"): _to_legacy_value(getattr(self, "author_id", None), serialize),
+            ("authorName" if serialize else "author_name"): _to_legacy_value(getattr(self, "author_name", None), serialize),
+            ("capacity" if serialize else "capacity"): _to_legacy_value(getattr(self, "capacity", None), serialize),
+            ("created_at" if serialize else "created_at"): _to_legacy_value(getattr(self, "created_at", None), serialize),
+            ("defaultContentSettings" if serialize else "default_content_settings"): _to_legacy_value(getattr(self, "default_content_settings", None), serialize),
+            ("description" if serialize else "description"): _to_legacy_value(getattr(self, "description", None), serialize),
+            ("favoriteGroup" if serialize else "favorite_group"): _to_legacy_value(getattr(self, "favorite_group", None), serialize),
+            ("favoriteId" if serialize else "favorite_id"): _to_legacy_value(getattr(self, "favorite_id", None), serialize),
+            ("favorites" if serialize else "favorites"): _to_legacy_value(getattr(self, "favorites", None), serialize),
+            ("featured" if serialize else "featured"): _to_legacy_value(getattr(self, "featured", None), serialize),
+            ("heat" if serialize else "heat"): _to_legacy_value(getattr(self, "heat", None), serialize),
+            ("id" if serialize else "id"): _to_legacy_value(getattr(self, "id", None), serialize),
+            ("imageUrl" if serialize else "image_url"): _to_legacy_value(getattr(self, "image_url", None), serialize),
+            ("labsPublicationDate" if serialize else "labs_publication_date"): _to_legacy_value(getattr(self, "labs_publication_date", None), serialize),
+            ("name" if serialize else "name"): _to_legacy_value(getattr(self, "name", None), serialize),
+            ("occupants" if serialize else "occupants"): _to_legacy_value(getattr(self, "occupants", None), serialize),
+            ("organization" if serialize else "organization"): _to_legacy_value(getattr(self, "organization", None), serialize),
+            ("popularity" if serialize else "popularity"): _to_legacy_value(getattr(self, "popularity", None), serialize),
+            ("previewYoutubeId" if serialize else "preview_youtube_id"): _to_legacy_value(getattr(self, "preview_youtube_id", None), serialize),
+            ("publicationDate" if serialize else "publication_date"): _to_legacy_value(getattr(self, "publication_date", None), serialize),
+            ("recommendedCapacity" if serialize else "recommended_capacity"): _to_legacy_value(getattr(self, "recommended_capacity", None), serialize),
+            ("releaseStatus" if serialize else "release_status"): _to_legacy_value(getattr(self, "release_status", None), serialize),
+            ("tags" if serialize else "tags"): _to_legacy_value(getattr(self, "tags", None), serialize),
+            ("thumbnailImageUrl" if serialize else "thumbnail_image_url"): _to_legacy_value(getattr(self, "thumbnail_image_url", None), serialize),
+            ("udonProducts" if serialize else "udon_products"): _to_legacy_value(getattr(self, "udon_products", None), serialize),
+            ("unityPackages" if serialize else "unity_packages"): _to_legacy_value(getattr(self, "unity_packages", None), serialize),
+            ("updated_at" if serialize else "updated_at"): _to_legacy_value(getattr(self, "updated_at", None), serialize),
+            ("urlList" if serialize else "url_list"): _to_legacy_value(getattr(self, "url_list", None), serialize),
+            ("version" if serialize else "version"): _to_legacy_value(getattr(self, "version", None), serialize),
+            ("visits" if serialize else "visits"): _to_legacy_value(getattr(self, "visits", 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of default_content_settings
+        if self.default_content_settings:
+            _dict['defaultContentSettings'] = _to_openapi_value(self.default_content_settings)
+        # override the default output from pydantic by calling `to_dict()` of each item in unity_packages (list)
+        _items = []
+        if self.unity_packages:
+            for _item_unity_packages in self.unity_packages:
+                if _item_unity_packages:
+                    _items.append(_to_openapi_value(_item_unity_packages))
+            _dict['unityPackages'] = _items
+        # set to None if preview_youtube_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.preview_youtube_id is None and "preview_youtube_id" in self.model_fields_set:
+            _dict['previewYoutubeId'] = None
+
+        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 FavoritedWorld 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({
+            "authorId": obj.get("authorId"),
+            "authorName": obj.get("authorName"),
+            "capacity": obj.get("capacity"),
+            "created_at": obj.get("created_at"),
+            "defaultContentSettings": InstanceContentSettings.from_dict(obj["defaultContentSettings"]) if obj.get("defaultContentSettings") is not None else None,
+            "description": obj.get("description"),
+            "favoriteGroup": obj.get("favoriteGroup"),
+            "favoriteId": obj.get("favoriteId"),
+            "favorites": obj.get("favorites") if obj.get("favorites") is not None else 0,
+            "featured": obj.get("featured") if obj.get("featured") is not None else False,
+            "heat": obj.get("heat") if obj.get("heat") is not None else 0,
+            "id": obj.get("id"),
+            "imageUrl": obj.get("imageUrl"),
+            "labsPublicationDate": obj.get("labsPublicationDate"),
+            "name": obj.get("name"),
+            "occupants": obj.get("occupants") if obj.get("occupants") is not None else 0,
+            "organization": obj.get("organization") if obj.get("organization") is not None else 'vrchat',
+            "popularity": obj.get("popularity") if obj.get("popularity") is not None else 0,
+            "previewYoutubeId": obj.get("previewYoutubeId"),
+            "publicationDate": obj.get("publicationDate"),
+            "recommendedCapacity": obj.get("recommendedCapacity"),
+            "releaseStatus": obj.get("releaseStatus") if obj.get("releaseStatus") is not None else ReleaseStatus.PUBLIC,
+            "tags": obj.get("tags"),
+            "thumbnailImageUrl": obj.get("thumbnailImageUrl"),
+            "udonProducts": obj.get("udonProducts"),
+            "unityPackages": [UnityPackage.from_dict(_item) for _item in obj["unityPackages"]] if obj.get("unityPackages") is not None else None,
+            "updated_at": obj.get("updated_at"),
+            "urlList": obj.get("urlList"),
+            "version": obj.get("version"),
+            "visits": obj.get("visits") if obj.get("visits") is not None else 0
+        })
+        return _obj
+
+