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

vrchatapi/models/group_announcement.py

@@ -0,0 +1,315 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+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 GroupAnnouncement(BaseModel):
+    """
+    GroupAnnouncement
+
+    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"]})
+    created_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("createdAt", "created_at"), serialization_alias="createdAt")
+    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"]})
+    id: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["gpos_71a7ff59-112c-4e78-a990-c7cc650776e5"]})
+    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")
+    text: Optional[StrictStr] = None
+    title: Optional[StrictStr] = None
+    updated_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("updatedAt", "updated_at"), serialization_alias="updatedAt")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "author_id": "str",
+        "created_at": "datetime",
+        "group_id": "str",
+        "id": "str",
+        "image_id": "str",
+        "image_url": "str",
+        "text": "str",
+        "title": "str",
+        "updated_at": "datetime"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "author_id": "authorId",
+        "created_at": "createdAt",
+        "group_id": "groupId",
+        "id": "id",
+        "image_id": "imageId",
+        "image_url": "imageUrl",
+        "text": "text",
+        "title": "title",
+        "updated_at": "updatedAt"
+    }
+    __properties: ClassVar[List[str]] = ["authorId", "createdAt", "groupId", "id", "imageId", "imageUrl", "text", "title", "updatedAt"]
+
+    @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 "createdAt" not in obj and "created_at" in obj:
+            obj["createdAt"] = obj["created_at"]
+        obj.pop("created_at", None)
+        if "groupId" not in obj and "group_id" in obj:
+            obj["groupId"] = obj["group_id"]
+        obj.pop("group_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 "updatedAt" not in obj and "updated_at" in obj:
+            obj["updatedAt"] = obj["updated_at"]
+        obj.pop("updated_at", 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, GroupAnnouncement):
+            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, GroupAnnouncement):
+            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 GroupAnnouncement 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),
+            ("createdAt" if serialize else "created_at"): _to_legacy_value(getattr(self, "created_at", None), serialize),
+            ("groupId" if serialize else "group_id"): _to_legacy_value(getattr(self, "group_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),
+            ("text" if serialize else "text"): _to_legacy_value(getattr(self, "text", None), serialize),
+            ("title" if serialize else "title"): _to_legacy_value(getattr(self, "title", None), serialize),
+            ("updatedAt" if serialize else "updated_at"): _to_legacy_value(getattr(self, "updated_at", 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 created_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.created_at is None and "created_at" in self.model_fields_set:
+            _dict['createdAt'] = None
+
+        # 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 text (nullable) is None
+        # and model_fields_set contains the field
+        if self.text is None and "text" in self.model_fields_set:
+            _dict['text'] = None
+
+        # set to None if title (nullable) is None
+        # and model_fields_set contains the field
+        if self.title is None and "title" in self.model_fields_set:
+            _dict['title'] = None
+
+        # set to None if updated_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.updated_at is None and "updated_at" in self.model_fields_set:
+            _dict['updatedAt'] = 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 GroupAnnouncement 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"),
+            "createdAt": obj.get("createdAt"),
+            "groupId": obj.get("groupId"),
+            "id": obj.get("id"),
+            "imageId": obj.get("imageId"),
+            "imageUrl": obj.get("imageUrl"),
+            "text": obj.get("text"),
+            "title": obj.get("title"),
+            "updatedAt": obj.get("updatedAt")
+        })
+        return _obj
+
+

vrchatapi/models/group_audit_log_entry.py

@@ -0,0 +1,287 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+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 GroupAuditLogEntry(BaseModel):
+    """
+    GroupAuditLogEntry
+
+    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
+    actor_display_name: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("actorDisplayName", "actor_display_name"), serialization_alias="actorDisplayName")
+    actor_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("actorId", "actor_id"), serialization_alias="actorId", 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"]})
+    created_at: Optional[datetime] = None
+    data: Optional[Dict[str, Any]] = Field(default=None, description="The data associated with the event. The format of this data is dependent on the event type.", json_schema_extra={"examples": [{"description": {"new": "My exciting new group. It's pretty nifty!", "old": "My exciting new group.  It's pretty nifty!"}, "joinState": {"new": "request", "old": "closed"}}]})
+    description: Optional[StrictStr] = Field(default=None, description="A human-readable description of the event.", json_schema_extra={"examples": ["Group role updated"]})
+    event_type: Optional[StrictStr] = Field(default='group.update', validation_alias=AliasChoices("eventType", "event_type"), serialization_alias="eventType", description="The type of event that occurred. This is a string that is prefixed with the type of object that the event occurred on. For example, a group role update event would be prefixed with `group.role`.", json_schema_extra={"examples": ["group.role.update"]})
+    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"]})
+    id: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["gaud_71a7ff59-112c-4e78-a990-c7cc650776e5"]})
+    target_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("targetId", "target_id"), serialization_alias="targetId", description="Typically a UserID, GroupID, GroupRoleID, or Location, but could be other types of IDs.")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "actor_display_name": "str",
+        "actor_id": "str",
+        "created_at": "datetime",
+        "data": "object",
+        "description": "str",
+        "event_type": "str",
+        "group_id": "str",
+        "id": "str",
+        "target_id": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "actor_display_name": "actorDisplayName",
+        "actor_id": "actorId",
+        "created_at": "created_at",
+        "data": "data",
+        "description": "description",
+        "event_type": "eventType",
+        "group_id": "groupId",
+        "id": "id",
+        "target_id": "targetId"
+    }
+    __properties: ClassVar[List[str]] = ["actorDisplayName", "actorId", "created_at", "data", "description", "eventType", "groupId", "id", "targetId"]
+
+    @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 "actorDisplayName" not in obj and "actor_display_name" in obj:
+            obj["actorDisplayName"] = obj["actor_display_name"]
+        obj.pop("actor_display_name", None)
+        if "actorId" not in obj and "actor_id" in obj:
+            obj["actorId"] = obj["actor_id"]
+        obj.pop("actor_id", None)
+        if "eventType" not in obj and "event_type" in obj:
+            obj["eventType"] = obj["event_type"]
+        obj.pop("event_type", None)
+        if "groupId" not in obj and "group_id" in obj:
+            obj["groupId"] = obj["group_id"]
+        obj.pop("group_id", None)
+        if "targetId" not in obj and "target_id" in obj:
+            obj["targetId"] = obj["target_id"]
+        obj.pop("target_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, GroupAuditLogEntry):
+            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, GroupAuditLogEntry):
+            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 GroupAuditLogEntry 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 {
+            ("actorDisplayName" if serialize else "actor_display_name"): _to_legacy_value(getattr(self, "actor_display_name", None), serialize),
+            ("actorId" if serialize else "actor_id"): _to_legacy_value(getattr(self, "actor_id", None), serialize),
+            ("created_at" if serialize else "created_at"): _to_legacy_value(getattr(self, "created_at", None), serialize),
+            ("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),
+            ("eventType" if serialize else "event_type"): _to_legacy_value(getattr(self, "event_type", None), serialize),
+            ("groupId" if serialize else "group_id"): _to_legacy_value(getattr(self, "group_id", None), serialize),
+            ("id" if serialize else "id"): _to_legacy_value(getattr(self, "id", None), serialize),
+            ("targetId" if serialize else "target_id"): _to_legacy_value(getattr(self, "target_id", 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 GroupAuditLogEntry 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({
+            "actorDisplayName": obj.get("actorDisplayName"),
+            "actorId": obj.get("actorId"),
+            "created_at": obj.get("created_at"),
+            "data": obj.get("data"),
+            "description": obj.get("description"),
+            "eventType": obj.get("eventType") if obj.get("eventType") is not None else 'group.update',
+            "groupId": obj.get("groupId"),
+            "id": obj.get("id"),
+            "targetId": obj.get("targetId")
+        })
+        return _obj
+
+