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

vrchatapi/models/inventory_item.py

@@ -0,0 +1,420 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from typing_extensions import Annotated
+from vrchatapi.models.inventory_default_attributes_value import InventoryDefaultAttributesValue
+from vrchatapi.models.inventory_equip_slot import InventoryEquipSlot
+from vrchatapi.models.inventory_item_type import InventoryItemType
+from vrchatapi.models.inventory_metadata import InventoryMetadata
+from vrchatapi.models.inventory_user_attributes import InventoryUserAttributes
+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 InventoryItem(BaseModel):
+    """
+    InventoryItem
+
+    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
+    collections: Optional[List[StrictStr]] = None
+    created_at: Optional[datetime] = Field(default=None, json_schema_extra={"examples": ["2025-06-13T05:00:45.455Z"]})
+    default_attributes: Optional[Dict[str, InventoryDefaultAttributesValue]] = Field(default=None, validation_alias=AliasChoices("defaultAttributes", "default_attributes"), serialization_alias="defaultAttributes")
+    description: Optional[StrictStr] = None
+    equip_slot: Optional[InventoryEquipSlot] = Field(default=InventoryEquipSlot.EMPTY, validation_alias=AliasChoices("equipSlot", "equip_slot"), serialization_alias="equipSlot")
+    equip_slots: Optional[List[InventoryEquipSlot]] = Field(default=None, validation_alias=AliasChoices("equipSlots", "equip_slots"), serialization_alias="equipSlots")
+    expiry_date: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("expiryDate", "expiry_date"), serialization_alias="expiryDate", json_schema_extra={"examples": ["2025-06-13T05:00:45.455Z"]})
+    flags: Optional[List[StrictStr]] = None
+    holder_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("holderId", "holder_id"), serialization_alias="holderId", 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"]})
+    id: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["inv_10bce5b0-2d2b-44e0-900d-db6534615162"]})
+    image_url: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("imageUrl", "image_url"), serialization_alias="imageUrl")
+    is_archived: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("isArchived", "is_archived"), serialization_alias="isArchived")
+    is_seen: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("isSeen", "is_seen"), serialization_alias="isSeen")
+    item_type: Optional[InventoryItemType] = Field(default=None, validation_alias=AliasChoices("itemType", "item_type"), serialization_alias="itemType")
+    item_type_label: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("itemTypeLabel", "item_type_label"), serialization_alias="itemTypeLabel")
+    metadata: Optional[InventoryMetadata] = None
+    name: Optional[StrictStr] = None
+    quantifiable: Optional[StrictBool] = None
+    tags: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = None
+    template_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("templateId", "template_id"), serialization_alias="templateId", json_schema_extra={"examples": ["invt_b80ce14b-038b-4f56-b970-d232771d62e3"]})
+    template_created_at: Optional[datetime] = Field(default=None, json_schema_extra={"examples": ["2025-06-09T16:31:40.785Z"]})
+    template_updated_at: Optional[datetime] = Field(default=None, json_schema_extra={"examples": ["2025-06-25T00:34:14.578Z"]})
+    updated_at: Optional[datetime] = Field(default=None, json_schema_extra={"examples": ["2025-06-25T00:34:15.965Z"]})
+    user_attributes: Optional[InventoryUserAttributes] = Field(default=None, validation_alias=AliasChoices("userAttributes", "user_attributes"), serialization_alias="userAttributes")
+    validate_user_attributes: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("validateUserAttributes", "validate_user_attributes"), serialization_alias="validateUserAttributes")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "collections": "List[str]",
+        "created_at": "datetime",
+        "default_attributes": "Dict[str, InventoryDefaultAttributesValue]",
+        "description": "str",
+        "equip_slot": "InventoryEquipSlot",
+        "equip_slots": "List[InventoryEquipSlot]",
+        "expiry_date": "datetime",
+        "flags": "List[str]",
+        "holder_id": "str",
+        "id": "str",
+        "image_url": "str",
+        "is_archived": "bool",
+        "is_seen": "bool",
+        "item_type": "InventoryItemType",
+        "item_type_label": "str",
+        "metadata": "InventoryMetadata",
+        "name": "str",
+        "quantifiable": "bool",
+        "tags": "List[str]",
+        "template_id": "str",
+        "template_created_at": "datetime",
+        "template_updated_at": "datetime",
+        "updated_at": "datetime",
+        "user_attributes": "InventoryUserAttributes",
+        "validate_user_attributes": "bool"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "collections": "collections",
+        "created_at": "created_at",
+        "default_attributes": "defaultAttributes",
+        "description": "description",
+        "equip_slot": "equipSlot",
+        "equip_slots": "equipSlots",
+        "expiry_date": "expiryDate",
+        "flags": "flags",
+        "holder_id": "holderId",
+        "id": "id",
+        "image_url": "imageUrl",
+        "is_archived": "isArchived",
+        "is_seen": "isSeen",
+        "item_type": "itemType",
+        "item_type_label": "itemTypeLabel",
+        "metadata": "metadata",
+        "name": "name",
+        "quantifiable": "quantifiable",
+        "tags": "tags",
+        "template_id": "templateId",
+        "template_created_at": "template_created_at",
+        "template_updated_at": "template_updated_at",
+        "updated_at": "updated_at",
+        "user_attributes": "userAttributes",
+        "validate_user_attributes": "validateUserAttributes"
+    }
+    __properties: ClassVar[List[str]] = ["collections", "created_at", "defaultAttributes", "description", "equipSlot", "equipSlots", "expiryDate", "flags", "holderId", "id", "imageUrl", "isArchived", "isSeen", "itemType", "itemTypeLabel", "metadata", "name", "quantifiable", "tags", "templateId", "template_created_at", "template_updated_at", "updated_at", "userAttributes", "validateUserAttributes"]
+
+    @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 "defaultAttributes" not in obj and "default_attributes" in obj:
+            obj["defaultAttributes"] = obj["default_attributes"]
+        obj.pop("default_attributes", None)
+        if "equipSlot" not in obj and "equip_slot" in obj:
+            obj["equipSlot"] = obj["equip_slot"]
+        obj.pop("equip_slot", None)
+        if "equipSlots" not in obj and "equip_slots" in obj:
+            obj["equipSlots"] = obj["equip_slots"]
+        obj.pop("equip_slots", None)
+        if "expiryDate" not in obj and "expiry_date" in obj:
+            obj["expiryDate"] = obj["expiry_date"]
+        obj.pop("expiry_date", None)
+        if "holderId" not in obj and "holder_id" in obj:
+            obj["holderId"] = obj["holder_id"]
+        obj.pop("holder_id", None)
+        if "imageUrl" not in obj and "image_url" in obj:
+            obj["imageUrl"] = obj["image_url"]
+        obj.pop("image_url", None)
+        if "isArchived" not in obj and "is_archived" in obj:
+            obj["isArchived"] = obj["is_archived"]
+        obj.pop("is_archived", None)
+        if "isSeen" not in obj and "is_seen" in obj:
+            obj["isSeen"] = obj["is_seen"]
+        obj.pop("is_seen", None)
+        if "itemType" not in obj and "item_type" in obj:
+            obj["itemType"] = obj["item_type"]
+        obj.pop("item_type", None)
+        if "itemTypeLabel" not in obj and "item_type_label" in obj:
+            obj["itemTypeLabel"] = obj["item_type_label"]
+        obj.pop("item_type_label", None)
+        if "templateId" not in obj and "template_id" in obj:
+            obj["templateId"] = obj["template_id"]
+        obj.pop("template_id", None)
+        if "userAttributes" not in obj and "user_attributes" in obj:
+            obj["userAttributes"] = obj["user_attributes"]
+        obj.pop("user_attributes", None)
+        if "validateUserAttributes" not in obj and "validate_user_attributes" in obj:
+            obj["validateUserAttributes"] = obj["validate_user_attributes"]
+        obj.pop("validate_user_attributes", 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, InventoryItem):
+            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, InventoryItem):
+            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 InventoryItem 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 {
+            ("collections" if serialize else "collections"): _to_legacy_value(getattr(self, "collections", None), serialize),
+            ("created_at" if serialize else "created_at"): _to_legacy_value(getattr(self, "created_at", None), serialize),
+            ("defaultAttributes" if serialize else "default_attributes"): _to_legacy_value(getattr(self, "default_attributes", None), serialize),
+            ("description" if serialize else "description"): _to_legacy_value(getattr(self, "description", None), serialize),
+            ("equipSlot" if serialize else "equip_slot"): _to_legacy_value(getattr(self, "equip_slot", None), serialize),
+            ("equipSlots" if serialize else "equip_slots"): _to_legacy_value(getattr(self, "equip_slots", None), serialize),
+            ("expiryDate" if serialize else "expiry_date"): _to_legacy_value(getattr(self, "expiry_date", None), serialize),
+            ("flags" if serialize else "flags"): _to_legacy_value(getattr(self, "flags", None), serialize),
+            ("holderId" if serialize else "holder_id"): _to_legacy_value(getattr(self, "holder_id", 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),
+            ("isArchived" if serialize else "is_archived"): _to_legacy_value(getattr(self, "is_archived", None), serialize),
+            ("isSeen" if serialize else "is_seen"): _to_legacy_value(getattr(self, "is_seen", None), serialize),
+            ("itemType" if serialize else "item_type"): _to_legacy_value(getattr(self, "item_type", None), serialize),
+            ("itemTypeLabel" if serialize else "item_type_label"): _to_legacy_value(getattr(self, "item_type_label", None), serialize),
+            ("metadata" if serialize else "metadata"): _to_legacy_value(getattr(self, "metadata", None), serialize),
+            ("name" if serialize else "name"): _to_legacy_value(getattr(self, "name", None), serialize),
+            ("quantifiable" if serialize else "quantifiable"): _to_legacy_value(getattr(self, "quantifiable", None), serialize),
+            ("tags" if serialize else "tags"): _to_legacy_value(getattr(self, "tags", None), serialize),
+            ("templateId" if serialize else "template_id"): _to_legacy_value(getattr(self, "template_id", None), serialize),
+            ("template_created_at" if serialize else "template_created_at"): _to_legacy_value(getattr(self, "template_created_at", None), serialize),
+            ("template_updated_at" if serialize else "template_updated_at"): _to_legacy_value(getattr(self, "template_updated_at", None), serialize),
+            ("updated_at" if serialize else "updated_at"): _to_legacy_value(getattr(self, "updated_at", None), serialize),
+            ("userAttributes" if serialize else "user_attributes"): _to_legacy_value(getattr(self, "user_attributes", None), serialize),
+            ("validateUserAttributes" if serialize else "validate_user_attributes"): _to_legacy_value(getattr(self, "validate_user_attributes", 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 each value in default_attributes (dict)
+        _field_dict = {}
+        if self.default_attributes:
+            for _key_default_attributes in self.default_attributes:
+                if self.default_attributes[_key_default_attributes]:
+                    _field_dict[_key_default_attributes] = _to_openapi_value(self.default_attributes[_key_default_attributes])
+            _dict['defaultAttributes'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of metadata
+        if self.metadata:
+            _dict['metadata'] = _to_openapi_value(self.metadata)
+        # override the default output from pydantic by calling `to_dict()` of user_attributes
+        if self.user_attributes:
+            _dict['userAttributes'] = _to_openapi_value(self.user_attributes)
+        # set to None if expiry_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.expiry_date is None and "expiry_date" in self.model_fields_set:
+            _dict['expiryDate'] = 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 InventoryItem 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({
+            "collections": obj.get("collections"),
+            "created_at": obj.get("created_at"),
+            "defaultAttributes": dict(
+                (_k, InventoryDefaultAttributesValue.from_dict(_v))
+                for _k, _v in obj["defaultAttributes"].items()
+            )
+            if obj.get("defaultAttributes") is not None
+            else None,
+            "description": obj.get("description"),
+            "equipSlot": obj.get("equipSlot") if obj.get("equipSlot") is not None else InventoryEquipSlot.EMPTY,
+            "equipSlots": obj.get("equipSlots"),
+            "expiryDate": obj.get("expiryDate"),
+            "flags": obj.get("flags"),
+            "holderId": obj.get("holderId"),
+            "id": obj.get("id"),
+            "imageUrl": obj.get("imageUrl"),
+            "isArchived": obj.get("isArchived"),
+            "isSeen": obj.get("isSeen"),
+            "itemType": obj.get("itemType") if obj.get("itemType") is not None else InventoryItemType.BUNDLE,
+            "itemTypeLabel": obj.get("itemTypeLabel"),
+            "metadata": InventoryMetadata.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None,
+            "name": obj.get("name"),
+            "quantifiable": obj.get("quantifiable"),
+            "tags": obj.get("tags"),
+            "templateId": obj.get("templateId"),
+            "template_created_at": obj.get("template_created_at"),
+            "template_updated_at": obj.get("template_updated_at"),
+            "updated_at": obj.get("updated_at"),
+            "userAttributes": InventoryUserAttributes.from_dict(obj["userAttributes"]) if obj.get("userAttributes") is not None else None,
+            "validateUserAttributes": obj.get("validateUserAttributes")
+        })
+        return _obj
+
+

vrchatapi/models/inventory_item_type.py

@@ -0,0 +1,42 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class InventoryItemType(str, Enum):
+    """
+    InventoryItemType
+    """
+
+    """
+    allowed enum values
+    """
+    BUNDLE = 'bundle'
+    DRONESKIN = 'droneskin'
+    EMOJI = 'emoji'
+    PORTALSKIN = 'portalskin'
+    PROP = 'prop'
+    STICKER = 'sticker'
+    WARPEFFECT = 'warpeffect'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of InventoryItemType from a JSON string"""
+        return cls(json.loads(json_str))
+
+