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

vrchatapi/models/avatar.py

@@ -0,0 +1,463 @@
+# 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.avatar_performance import AvatarPerformance
+from vrchatapi.models.avatar_published_listings_inner import AvatarPublishedListingsInner
+from vrchatapi.models.avatar_styles import AvatarStyles
+from vrchatapi.models.avatar_unity_package_url_object import AvatarUnityPackageUrlObject
+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 Avatar(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
+    acknowledgements: Optional[StrictStr] = None
+    active_asset_review_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("activeAssetReviewId", "active_asset_review_id"), serialization_alias="activeAssetReviewId", description="Only present for the avatar author on avatars under active review.")
+    asset_url: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("assetUrl", "asset_url"), serialization_alias="assetUrl", description="Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`.")
+    asset_url_object: Optional[Dict[str, Any]] = Field(default=None, validation_alias=AliasChoices("assetUrlObject", "asset_url_object"), serialization_alias="assetUrlObject", description="Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`. **Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead.")
+    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")
+    created_at: Optional[datetime] = None
+    description: Optional[Annotated[str, Field(min_length=0, strict=True)]] = None
+    featured: Optional[StrictBool] = None
+    highest_price: Optional[StrictInt] = Field(default=None, validation_alias=AliasChoices("highestPrice", "highest_price"), serialization_alias="highestPrice")
+    id: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["avtr_912d66a4-4714-43b8-8407-7de2cafbf55b"]})
+    image_url: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("imageUrl", "image_url"), serialization_alias="imageUrl")
+    listing_date: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("listingDate", "listing_date"), serialization_alias="listingDate")
+    lock: Optional[StrictBool] = None
+    lowest_price: Optional[StrictInt] = Field(default=None, validation_alias=AliasChoices("lowestPrice", "lowest_price"), serialization_alias="lowestPrice")
+    name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None
+    pending_upload: Optional[StrictBool] = Field(default=False, validation_alias=AliasChoices("pendingUpload", "pending_upload"), serialization_alias="pendingUpload")
+    performance: Optional[AvatarPerformance] = None
+    product_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("productId", "product_id"), serialization_alias="productId")
+    published_listings: Optional[List[AvatarPublishedListingsInner]] = Field(default=None, validation_alias=AliasChoices("publishedListings", "published_listings"), serialization_alias="publishedListings")
+    release_status: Optional[ReleaseStatus] = Field(default=None, validation_alias=AliasChoices("releaseStatus", "release_status"), serialization_alias="releaseStatus")
+    searchable: Optional[StrictBool] = False
+    styles: Optional[AvatarStyles] = None
+    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")
+    unity_package_url: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("unityPackageUrl", "unity_package_url"), serialization_alias="unityPackageUrl")
+    unity_package_url_object: Optional[AvatarUnityPackageUrlObject] = Field(default=None, validation_alias=AliasChoices("unityPackageUrlObject", "unity_package_url_object"), serialization_alias="unityPackageUrlObject")
+    unity_packages: Optional[Annotated[List[UnityPackage], Field(min_length=1)]] = Field(default=None, validation_alias=AliasChoices("unityPackages", "unity_packages"), serialization_alias="unityPackages")
+    updated_at: Optional[datetime] = None
+    version: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, json_schema_extra={"examples": [68]})
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "acknowledgements": "str",
+        "active_asset_review_id": "str",
+        "asset_url": "str",
+        "asset_url_object": "object",
+        "author_id": "str",
+        "author_name": "str",
+        "created_at": "datetime",
+        "description": "str",
+        "featured": "bool",
+        "highest_price": "int",
+        "id": "str",
+        "image_url": "str",
+        "listing_date": "str",
+        "lock": "bool",
+        "lowest_price": "int",
+        "name": "str",
+        "pending_upload": "bool",
+        "performance": "AvatarPerformance",
+        "product_id": "str",
+        "published_listings": "List[AvatarPublishedListingsInner]",
+        "release_status": "ReleaseStatus",
+        "searchable": "bool",
+        "styles": "AvatarStyles",
+        "tags": "List[str]",
+        "thumbnail_image_url": "str",
+        "unity_package_url": "str",
+        "unity_package_url_object": "AvatarUnityPackageUrlObject",
+        "unity_packages": "List[UnityPackage]",
+        "updated_at": "datetime",
+        "version": "int"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "acknowledgements": "acknowledgements",
+        "active_asset_review_id": "activeAssetReviewId",
+        "asset_url": "assetUrl",
+        "asset_url_object": "assetUrlObject",
+        "author_id": "authorId",
+        "author_name": "authorName",
+        "created_at": "created_at",
+        "description": "description",
+        "featured": "featured",
+        "highest_price": "highestPrice",
+        "id": "id",
+        "image_url": "imageUrl",
+        "listing_date": "listingDate",
+        "lock": "lock",
+        "lowest_price": "lowestPrice",
+        "name": "name",
+        "pending_upload": "pendingUpload",
+        "performance": "performance",
+        "product_id": "productId",
+        "published_listings": "publishedListings",
+        "release_status": "releaseStatus",
+        "searchable": "searchable",
+        "styles": "styles",
+        "tags": "tags",
+        "thumbnail_image_url": "thumbnailImageUrl",
+        "unity_package_url": "unityPackageUrl",
+        "unity_package_url_object": "unityPackageUrlObject",
+        "unity_packages": "unityPackages",
+        "updated_at": "updated_at",
+        "version": "version"
+    }
+    __properties: ClassVar[List[str]] = ["acknowledgements", "activeAssetReviewId", "assetUrl", "assetUrlObject", "authorId", "authorName", "created_at", "description", "featured", "highestPrice", "id", "imageUrl", "listingDate", "lock", "lowestPrice", "name", "pendingUpload", "performance", "productId", "publishedListings", "releaseStatus", "searchable", "styles", "tags", "thumbnailImageUrl", "unityPackageUrl", "unityPackageUrlObject", "unityPackages", "updated_at", "version"]
+
+    @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 "activeAssetReviewId" not in obj and "active_asset_review_id" in obj:
+            obj["activeAssetReviewId"] = obj["active_asset_review_id"]
+        obj.pop("active_asset_review_id", None)
+        if "assetUrl" not in obj and "asset_url" in obj:
+            obj["assetUrl"] = obj["asset_url"]
+        obj.pop("asset_url", None)
+        if "assetUrlObject" not in obj and "asset_url_object" in obj:
+            obj["assetUrlObject"] = obj["asset_url_object"]
+        obj.pop("asset_url_object", None)
+        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 "highestPrice" not in obj and "highest_price" in obj:
+            obj["highestPrice"] = obj["highest_price"]
+        obj.pop("highest_price", None)
+        if "imageUrl" not in obj and "image_url" in obj:
+            obj["imageUrl"] = obj["image_url"]
+        obj.pop("image_url", None)
+        if "listingDate" not in obj and "listing_date" in obj:
+            obj["listingDate"] = obj["listing_date"]
+        obj.pop("listing_date", None)
+        if "lowestPrice" not in obj and "lowest_price" in obj:
+            obj["lowestPrice"] = obj["lowest_price"]
+        obj.pop("lowest_price", None)
+        if "pendingUpload" not in obj and "pending_upload" in obj:
+            obj["pendingUpload"] = obj["pending_upload"]
+        obj.pop("pending_upload", None)
+        if "productId" not in obj and "product_id" in obj:
+            obj["productId"] = obj["product_id"]
+        obj.pop("product_id", None)
+        if "publishedListings" not in obj and "published_listings" in obj:
+            obj["publishedListings"] = obj["published_listings"]
+        obj.pop("published_listings", 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 "unityPackageUrl" not in obj and "unity_package_url" in obj:
+            obj["unityPackageUrl"] = obj["unity_package_url"]
+        obj.pop("unity_package_url", None)
+        if "unityPackageUrlObject" not in obj and "unity_package_url_object" in obj:
+            obj["unityPackageUrlObject"] = obj["unity_package_url_object"]
+        obj.pop("unity_package_url_object", None)
+        if "unityPackages" not in obj and "unity_packages" in obj:
+            obj["unityPackages"] = obj["unity_packages"]
+        obj.pop("unity_packages", 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, Avatar):
+            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, Avatar):
+            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 Avatar 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 {
+            ("acknowledgements" if serialize else "acknowledgements"): _to_legacy_value(getattr(self, "acknowledgements", None), serialize),
+            ("activeAssetReviewId" if serialize else "active_asset_review_id"): _to_legacy_value(getattr(self, "active_asset_review_id", None), serialize),
+            ("assetUrl" if serialize else "asset_url"): _to_legacy_value(getattr(self, "asset_url", None), serialize),
+            ("assetUrlObject" if serialize else "asset_url_object"): _to_legacy_value(getattr(self, "asset_url_object", None), serialize),
+            ("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),
+            ("created_at" if serialize else "created_at"): _to_legacy_value(getattr(self, "created_at", None), serialize),
+            ("description" if serialize else "description"): _to_legacy_value(getattr(self, "description", None), serialize),
+            ("featured" if serialize else "featured"): _to_legacy_value(getattr(self, "featured", None), serialize),
+            ("highestPrice" if serialize else "highest_price"): _to_legacy_value(getattr(self, "highest_price", 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),
+            ("listingDate" if serialize else "listing_date"): _to_legacy_value(getattr(self, "listing_date", None), serialize),
+            ("lock" if serialize else "lock"): _to_legacy_value(getattr(self, "lock", None), serialize),
+            ("lowestPrice" if serialize else "lowest_price"): _to_legacy_value(getattr(self, "lowest_price", None), serialize),
+            ("name" if serialize else "name"): _to_legacy_value(getattr(self, "name", None), serialize),
+            ("pendingUpload" if serialize else "pending_upload"): _to_legacy_value(getattr(self, "pending_upload", None), serialize),
+            ("performance" if serialize else "performance"): _to_legacy_value(getattr(self, "performance", None), serialize),
+            ("productId" if serialize else "product_id"): _to_legacy_value(getattr(self, "product_id", None), serialize),
+            ("publishedListings" if serialize else "published_listings"): _to_legacy_value(getattr(self, "published_listings", None), serialize),
+            ("releaseStatus" if serialize else "release_status"): _to_legacy_value(getattr(self, "release_status", None), serialize),
+            ("searchable" if serialize else "searchable"): _to_legacy_value(getattr(self, "searchable", None), serialize),
+            ("styles" if serialize else "styles"): _to_legacy_value(getattr(self, "styles", 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),
+            ("unityPackageUrl" if serialize else "unity_package_url"): _to_legacy_value(getattr(self, "unity_package_url", None), serialize),
+            ("unityPackageUrlObject" if serialize else "unity_package_url_object"): _to_legacy_value(getattr(self, "unity_package_url_object", 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),
+            ("version" if serialize else "version"): _to_legacy_value(getattr(self, "version", 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 performance
+        if self.performance:
+            _dict['performance'] = _to_openapi_value(self.performance)
+        # override the default output from pydantic by calling `to_dict()` of each item in published_listings (list)
+        _items = []
+        if self.published_listings:
+            for _item_published_listings in self.published_listings:
+                if _item_published_listings:
+                    _items.append(_to_openapi_value(_item_published_listings))
+            _dict['publishedListings'] = _items
+        # override the default output from pydantic by calling `to_dict()` of styles
+        if self.styles:
+            _dict['styles'] = _to_openapi_value(self.styles)
+        # override the default output from pydantic by calling `to_dict()` of unity_package_url_object
+        if self.unity_package_url_object:
+            _dict['unityPackageUrlObject'] = _to_openapi_value(self.unity_package_url_object)
+        # 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 listing_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.listing_date is None and "listing_date" in self.model_fields_set:
+            _dict['listingDate'] = 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 Avatar 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({
+            "acknowledgements": obj.get("acknowledgements"),
+            "activeAssetReviewId": obj.get("activeAssetReviewId"),
+            "assetUrl": obj.get("assetUrl"),
+            "assetUrlObject": obj.get("assetUrlObject"),
+            "authorId": obj.get("authorId"),
+            "authorName": obj.get("authorName"),
+            "created_at": obj.get("created_at"),
+            "description": obj.get("description"),
+            "featured": obj.get("featured") if obj.get("featured") is not None else False,
+            "highestPrice": obj.get("highestPrice"),
+            "id": obj.get("id"),
+            "imageUrl": obj.get("imageUrl"),
+            "listingDate": obj.get("listingDate"),
+            "lock": obj.get("lock"),
+            "lowestPrice": obj.get("lowestPrice"),
+            "name": obj.get("name"),
+            "pendingUpload": obj.get("pendingUpload") if obj.get("pendingUpload") is not None else False,
+            "performance": AvatarPerformance.from_dict(obj["performance"]) if obj.get("performance") is not None else None,
+            "productId": obj.get("productId"),
+            "publishedListings": [AvatarPublishedListingsInner.from_dict(_item) for _item in obj["publishedListings"]] if obj.get("publishedListings") is not None else None,
+            "releaseStatus": obj.get("releaseStatus") if obj.get("releaseStatus") is not None else ReleaseStatus.PUBLIC,
+            "searchable": obj.get("searchable") if obj.get("searchable") is not None else False,
+            "styles": AvatarStyles.from_dict(obj["styles"]) if obj.get("styles") is not None else None,
+            "tags": obj.get("tags"),
+            "thumbnailImageUrl": obj.get("thumbnailImageUrl"),
+            "unityPackageUrl": obj.get("unityPackageUrl"),
+            "unityPackageUrlObject": AvatarUnityPackageUrlObject.from_dict(obj["unityPackageUrlObject"]) if obj.get("unityPackageUrlObject") is not None else None,
+            "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"),
+            "version": obj.get("version") if obj.get("version") is not None else 0
+        })
+        return _obj
+
+