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

vrchatapi/models/product.py

@@ -0,0 +1,389 @@
+# 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.product_type import ProductType
+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 Product(BaseModel):
+    """
+    Product
+
+    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
+    archived: Optional[StrictBool] = None
+    created: Optional[datetime] = None
+    description: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("displayName", "display_name"), serialization_alias="displayName")
+    group_access: Optional[StrictBool] = Field(default=False, validation_alias=AliasChoices("groupAccess", "group_access"), serialization_alias="groupAccess")
+    group_access_remove: Optional[StrictBool] = Field(default=False, validation_alias=AliasChoices("groupAccessRemove", "group_access_remove"), serialization_alias="groupAccessRemove")
+    group_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("groupId", "group_id"), serialization_alias="groupId", json_schema_extra={"examples": ["grp_71a7ff59-112c-4e78-a990-c7cc650776e5"]})
+    group_role_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("groupRoleId", "group_role_id"), serialization_alias="groupRoleId", json_schema_extra={"examples": ["grol_459d3911-f672-44bc-b84d-e54ffe7960fe"]})
+    id: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"]})
+    image_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("imageId", "image_id"), serialization_alias="imageId", json_schema_extra={"examples": ["file_ce35d830-e20a-4df0-a6d4-5aaef4508044"]})
+    image_url: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("imageUrl", "image_url"), serialization_alias="imageUrl")
+    parent_listings: Optional[List[StrictStr]] = Field(default=None, validation_alias=AliasChoices("parentListings", "parent_listings"), serialization_alias="parentListings")
+    product_type: Optional[ProductType] = Field(default=None, validation_alias=AliasChoices("productType", "product_type"), serialization_alias="productType")
+    product_type_label: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("productTypeLabel", "product_type_label"), serialization_alias="productTypeLabel")
+    purchase_count: Optional[StrictInt] = Field(default=None, validation_alias=AliasChoices("purchaseCount", "purchase_count"), serialization_alias="purchaseCount")
+    purchase_count_quantity: Optional[StrictInt] = Field(default=None, validation_alias=AliasChoices("purchaseCountQuantity", "purchase_count_quantity"), serialization_alias="purchaseCountQuantity")
+    seller_display_name: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("sellerDisplayName", "seller_display_name"), serialization_alias="sellerDisplayName")
+    seller_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("sellerId", "seller_id"), serialization_alias="sellerId")
+    tags: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = None
+    updated: Optional[datetime] = None
+    use_for_subscriber_list: Optional[StrictBool] = Field(default=False, validation_alias=AliasChoices("useForSubscriberList", "use_for_subscriber_list"), serialization_alias="useForSubscriberList")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "archived": "bool",
+        "created": "datetime",
+        "description": "str",
+        "display_name": "str",
+        "group_access": "bool",
+        "group_access_remove": "bool",
+        "group_id": "str",
+        "group_role_id": "str",
+        "id": "str",
+        "image_id": "str",
+        "image_url": "str",
+        "parent_listings": "List[str]",
+        "product_type": "ProductType",
+        "product_type_label": "str",
+        "purchase_count": "int",
+        "purchase_count_quantity": "int",
+        "seller_display_name": "str",
+        "seller_id": "str",
+        "tags": "List[str]",
+        "updated": "datetime",
+        "use_for_subscriber_list": "bool"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "archived": "archived",
+        "created": "created",
+        "description": "description",
+        "display_name": "displayName",
+        "group_access": "groupAccess",
+        "group_access_remove": "groupAccessRemove",
+        "group_id": "groupId",
+        "group_role_id": "groupRoleId",
+        "id": "id",
+        "image_id": "imageId",
+        "image_url": "imageUrl",
+        "parent_listings": "parentListings",
+        "product_type": "productType",
+        "product_type_label": "productTypeLabel",
+        "purchase_count": "purchaseCount",
+        "purchase_count_quantity": "purchaseCountQuantity",
+        "seller_display_name": "sellerDisplayName",
+        "seller_id": "sellerId",
+        "tags": "tags",
+        "updated": "updated",
+        "use_for_subscriber_list": "useForSubscriberList"
+    }
+    __properties: ClassVar[List[str]] = ["archived", "created", "description", "displayName", "groupAccess", "groupAccessRemove", "groupId", "groupRoleId", "id", "imageId", "imageUrl", "parentListings", "productType", "productTypeLabel", "purchaseCount", "purchaseCountQuantity", "sellerDisplayName", "sellerId", "tags", "updated", "useForSubscriberList"]
+
+    @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 "displayName" not in obj and "display_name" in obj:
+            obj["displayName"] = obj["display_name"]
+        obj.pop("display_name", None)
+        if "groupAccess" not in obj and "group_access" in obj:
+            obj["groupAccess"] = obj["group_access"]
+        obj.pop("group_access", None)
+        if "groupAccessRemove" not in obj and "group_access_remove" in obj:
+            obj["groupAccessRemove"] = obj["group_access_remove"]
+        obj.pop("group_access_remove", None)
+        if "groupId" not in obj and "group_id" in obj:
+            obj["groupId"] = obj["group_id"]
+        obj.pop("group_id", None)
+        if "groupRoleId" not in obj and "group_role_id" in obj:
+            obj["groupRoleId"] = obj["group_role_id"]
+        obj.pop("group_role_id", None)
+        if "imageId" not in obj and "image_id" in obj:
+            obj["imageId"] = obj["image_id"]
+        obj.pop("image_id", None)
+        if "imageUrl" not in obj and "image_url" in obj:
+            obj["imageUrl"] = obj["image_url"]
+        obj.pop("image_url", None)
+        if "parentListings" not in obj and "parent_listings" in obj:
+            obj["parentListings"] = obj["parent_listings"]
+        obj.pop("parent_listings", None)
+        if "productType" not in obj and "product_type" in obj:
+            obj["productType"] = obj["product_type"]
+        obj.pop("product_type", None)
+        if "productTypeLabel" not in obj and "product_type_label" in obj:
+            obj["productTypeLabel"] = obj["product_type_label"]
+        obj.pop("product_type_label", None)
+        if "purchaseCount" not in obj and "purchase_count" in obj:
+            obj["purchaseCount"] = obj["purchase_count"]
+        obj.pop("purchase_count", None)
+        if "purchaseCountQuantity" not in obj and "purchase_count_quantity" in obj:
+            obj["purchaseCountQuantity"] = obj["purchase_count_quantity"]
+        obj.pop("purchase_count_quantity", None)
+        if "sellerDisplayName" not in obj and "seller_display_name" in obj:
+            obj["sellerDisplayName"] = obj["seller_display_name"]
+        obj.pop("seller_display_name", None)
+        if "sellerId" not in obj and "seller_id" in obj:
+            obj["sellerId"] = obj["seller_id"]
+        obj.pop("seller_id", None)
+        if "useForSubscriberList" not in obj and "use_for_subscriber_list" in obj:
+            obj["useForSubscriberList"] = obj["use_for_subscriber_list"]
+        obj.pop("use_for_subscriber_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, Product):
+            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, Product):
+            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 Product 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 {
+            ("archived" if serialize else "archived"): _to_legacy_value(getattr(self, "archived", None), serialize),
+            ("created" if serialize else "created"): _to_legacy_value(getattr(self, "created", None), serialize),
+            ("description" if serialize else "description"): _to_legacy_value(getattr(self, "description", None), serialize),
+            ("displayName" if serialize else "display_name"): _to_legacy_value(getattr(self, "display_name", None), serialize),
+            ("groupAccess" if serialize else "group_access"): _to_legacy_value(getattr(self, "group_access", None), serialize),
+            ("groupAccessRemove" if serialize else "group_access_remove"): _to_legacy_value(getattr(self, "group_access_remove", None), serialize),
+            ("groupId" if serialize else "group_id"): _to_legacy_value(getattr(self, "group_id", None), serialize),
+            ("groupRoleId" if serialize else "group_role_id"): _to_legacy_value(getattr(self, "group_role_id", None), serialize),
+            ("id" if serialize else "id"): _to_legacy_value(getattr(self, "id", None), serialize),
+            ("imageId" if serialize else "image_id"): _to_legacy_value(getattr(self, "image_id", None), serialize),
+            ("imageUrl" if serialize else "image_url"): _to_legacy_value(getattr(self, "image_url", None), serialize),
+            ("parentListings" if serialize else "parent_listings"): _to_legacy_value(getattr(self, "parent_listings", None), serialize),
+            ("productType" if serialize else "product_type"): _to_legacy_value(getattr(self, "product_type", None), serialize),
+            ("productTypeLabel" if serialize else "product_type_label"): _to_legacy_value(getattr(self, "product_type_label", None), serialize),
+            ("purchaseCount" if serialize else "purchase_count"): _to_legacy_value(getattr(self, "purchase_count", None), serialize),
+            ("purchaseCountQuantity" if serialize else "purchase_count_quantity"): _to_legacy_value(getattr(self, "purchase_count_quantity", None), serialize),
+            ("sellerDisplayName" if serialize else "seller_display_name"): _to_legacy_value(getattr(self, "seller_display_name", None), serialize),
+            ("sellerId" if serialize else "seller_id"): _to_legacy_value(getattr(self, "seller_id", None), serialize),
+            ("tags" if serialize else "tags"): _to_legacy_value(getattr(self, "tags", None), serialize),
+            ("updated" if serialize else "updated"): _to_legacy_value(getattr(self, "updated", None), serialize),
+            ("useForSubscriberList" if serialize else "use_for_subscriber_list"): _to_legacy_value(getattr(self, "use_for_subscriber_list", 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,
+        )
+        # set to None if image_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.image_url is None and "image_url" in self.model_fields_set:
+            _dict['imageUrl'] = None
+
+        # set to None if updated (nullable) is None
+        # and model_fields_set contains the field
+        if self.updated is None and "updated" in self.model_fields_set:
+            _dict['updated'] = 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 Product 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({
+            "archived": obj.get("archived"),
+            "created": obj.get("created"),
+            "description": obj.get("description"),
+            "displayName": obj.get("displayName"),
+            "groupAccess": obj.get("groupAccess") if obj.get("groupAccess") is not None else False,
+            "groupAccessRemove": obj.get("groupAccessRemove") if obj.get("groupAccessRemove") is not None else False,
+            "groupId": obj.get("groupId"),
+            "groupRoleId": obj.get("groupRoleId"),
+            "id": obj.get("id"),
+            "imageId": obj.get("imageId"),
+            "imageUrl": obj.get("imageUrl"),
+            "parentListings": obj.get("parentListings"),
+            "productType": obj.get("productType") if obj.get("productType") is not None else ProductType.UDON,
+            "productTypeLabel": obj.get("productTypeLabel"),
+            "purchaseCount": obj.get("purchaseCount"),
+            "purchaseCountQuantity": obj.get("purchaseCountQuantity"),
+            "sellerDisplayName": obj.get("sellerDisplayName"),
+            "sellerId": obj.get("sellerId"),
+            "tags": obj.get("tags"),
+            "updated": obj.get("updated"),
+            "useForSubscriberList": obj.get("useForSubscriberList") if obj.get("useForSubscriberList") is not None else False
+        })
+        return _obj
+
+