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

vrchatapi/models/permission.py

@@ -0,0 +1,280 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from typing_extensions import Annotated
+from vrchatapi.models.permission_data import PermissionData
+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 Permission(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
+    data: Optional[PermissionData] = None
+    description: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("displayName", "display_name"), serialization_alias="displayName")
+    id: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["prms_804ba021-9f47-4e25-9847-1f42fdb2e6ff"]})
+    name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, json_schema_extra={"examples": ["permission-invite-photos"]})
+    owner_display_name: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("ownerDisplayName", "owner_display_name"), serialization_alias="ownerDisplayName")
+    owner_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("ownerId", "owner_id"), serialization_alias="ownerId", 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"]})
+    type: Optional[StrictStr] = None
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "data": "PermissionData",
+        "description": "str",
+        "display_name": "str",
+        "id": "str",
+        "name": "str",
+        "owner_display_name": "str",
+        "owner_id": "str",
+        "type": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "data": "data",
+        "description": "description",
+        "display_name": "displayName",
+        "id": "id",
+        "name": "name",
+        "owner_display_name": "ownerDisplayName",
+        "owner_id": "ownerId",
+        "type": "type"
+    }
+    __properties: ClassVar[List[str]] = ["data", "description", "displayName", "id", "name", "ownerDisplayName", "ownerId", "type"]
+
+    @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 "ownerDisplayName" not in obj and "owner_display_name" in obj:
+            obj["ownerDisplayName"] = obj["owner_display_name"]
+        obj.pop("owner_display_name", None)
+        if "ownerId" not in obj and "owner_id" in obj:
+            obj["ownerId"] = obj["owner_id"]
+        obj.pop("owner_id", 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, Permission):
+            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, Permission):
+            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 Permission 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 {
+            ("data" if serialize else "data"): _to_legacy_value(getattr(self, "data", 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),
+            ("id" if serialize else "id"): _to_legacy_value(getattr(self, "id", None), serialize),
+            ("name" if serialize else "name"): _to_legacy_value(getattr(self, "name", None), serialize),
+            ("ownerDisplayName" if serialize else "owner_display_name"): _to_legacy_value(getattr(self, "owner_display_name", None), serialize),
+            ("ownerId" if serialize else "owner_id"): _to_legacy_value(getattr(self, "owner_id", None), serialize),
+            ("type" if serialize else "type"): _to_legacy_value(getattr(self, "type", 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 data
+        if self.data:
+            _dict['data'] = _to_openapi_value(self.data)
+        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 Permission 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({
+            "data": PermissionData.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "description": obj.get("description"),
+            "displayName": obj.get("displayName"),
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "ownerDisplayName": obj.get("ownerDisplayName"),
+            "ownerId": obj.get("ownerId"),
+            "type": obj.get("type")
+        })
+        return _obj
+
+

vrchatapi/models/permission_data.py

@@ -0,0 +1,258 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from typing_extensions import Annotated
+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 PermissionData(BaseModel):
+    """
+    Specific values afforded the user by this permission
+
+    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
+    badges: Optional[List[StrictStr]] = Field(default=None, description="Badges afforded the user by this permission")
+    max: Optional[StrictInt] = Field(default=None, description="Maximum value afforded the user by this permission")
+    max_favorite_groups: Optional[Dict[str, StrictInt]] = Field(default=None, validation_alias=AliasChoices("maxFavoriteGroups", "max_favorite_groups"), serialization_alias="maxFavoriteGroups", description="Maximum favorite groups afforded the user by this permission")
+    max_favorites_per_group: Optional[Dict[str, StrictInt]] = Field(default=None, validation_alias=AliasChoices("maxFavoritesPerGroup", "max_favorites_per_group"), serialization_alias="maxFavoritesPerGroup", description="Maximum favorites per group afforded the user by this permission")
+    tags: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = Field(default=None, description="Tags afforded the user by this permission")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "badges": "List[str]",
+        "max": "int",
+        "max_favorite_groups": "Dict[str, int]",
+        "max_favorites_per_group": "Dict[str, int]",
+        "tags": "List[str]"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "badges": "badges",
+        "max": "max",
+        "max_favorite_groups": "maxFavoriteGroups",
+        "max_favorites_per_group": "maxFavoritesPerGroup",
+        "tags": "tags"
+    }
+    __properties: ClassVar[List[str]] = ["badges", "max", "maxFavoriteGroups", "maxFavoritesPerGroup", "tags"]
+
+    @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 "maxFavoriteGroups" not in obj and "max_favorite_groups" in obj:
+            obj["maxFavoriteGroups"] = obj["max_favorite_groups"]
+        obj.pop("max_favorite_groups", None)
+        if "maxFavoritesPerGroup" not in obj and "max_favorites_per_group" in obj:
+            obj["maxFavoritesPerGroup"] = obj["max_favorites_per_group"]
+        obj.pop("max_favorites_per_group", 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, PermissionData):
+            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, PermissionData):
+            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 PermissionData 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 {
+            ("badges" if serialize else "badges"): _to_legacy_value(getattr(self, "badges", None), serialize),
+            ("max" if serialize else "max"): _to_legacy_value(getattr(self, "max", None), serialize),
+            ("maxFavoriteGroups" if serialize else "max_favorite_groups"): _to_legacy_value(getattr(self, "max_favorite_groups", None), serialize),
+            ("maxFavoritesPerGroup" if serialize else "max_favorites_per_group"): _to_legacy_value(getattr(self, "max_favorites_per_group", None), serialize),
+            ("tags" if serialize else "tags"): _to_legacy_value(getattr(self, "tags", 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 PermissionData 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({
+            "badges": obj.get("badges"),
+            "max": obj.get("max"),
+            "maxFavoriteGroups": obj.get("maxFavoriteGroups"),
+            "maxFavoritesPerGroup": obj.get("maxFavoritesPerGroup"),
+            "tags": obj.get("tags")
+        })
+        return _obj
+
+