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

vrchatapi/models/group_member.py

@@ -0,0 +1,415 @@
+# 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 vrchatapi.models.group_member_limited_user import GroupMemberLimitedUser
+from vrchatapi.models.group_member_status import GroupMemberStatus
+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 GroupMember(BaseModel):
+    """
+    May be null when attempting to retrieve group membership for a user who is not part of the group
+
+    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
+    accepted_by_display_name: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("acceptedByDisplayName", "accepted_by_display_name"), serialization_alias="acceptedByDisplayName", description="Only missing when explicitly fetching own user.")
+    accepted_by_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("acceptedById", "accepted_by_id"), serialization_alias="acceptedById", description="Only missing when explicitly fetching own user.")
+    banned_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("bannedAt", "banned_at"), serialization_alias="bannedAt", description="Only missing when explicitly fetching own user.")
+    created_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("createdAt", "created_at"), serialization_alias="createdAt", description="Only missing when explicitly fetching own user.")
+    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"]})
+    has_joined_from_purchase: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("hasJoinedFromPurchase", "has_joined_from_purchase"), serialization_alias="hasJoinedFromPurchase", description="Missing when explicitly fetching own user, or when group isn't linked to a purchase.")
+    id: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["gmem_95cdb3b4-4643-4eb6-bdab-46a4e1e5ce37"]})
+    is_representing: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("isRepresenting", "is_representing"), serialization_alias="isRepresenting", description="Whether the user is representing the group. This makes the group show up above the name tag in-game.", json_schema_extra={"examples": [True]})
+    is_subscribed_to_announcements: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("isSubscribedToAnnouncements", "is_subscribed_to_announcements"), serialization_alias="isSubscribedToAnnouncements")
+    is_subscribed_to_event_announcements: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("isSubscribedToEventAnnouncements", "is_subscribed_to_event_announcements"), serialization_alias="isSubscribedToEventAnnouncements", description="Only missing when explicitly fetching own user.")
+    joined_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("joinedAt", "joined_at"), serialization_alias="joinedAt")
+    last_post_read_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("lastPostReadAt", "last_post_read_at"), serialization_alias="lastPostReadAt")
+    m_role_ids: Optional[List[StrictStr]] = Field(default=None, validation_alias=AliasChoices("mRoleIds", "m_role_ids"), serialization_alias="mRoleIds")
+    manager_notes: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("managerNotes", "manager_notes"), serialization_alias="managerNotes", description="Only missing when explicitly fetching own user.")
+    membership_status: Optional[GroupMemberStatus] = Field(default=None, validation_alias=AliasChoices("membershipStatus", "membership_status"), serialization_alias="membershipStatus")
+    role_ids: Optional[List[StrictStr]] = Field(default=None, validation_alias=AliasChoices("roleIds", "role_ids"), serialization_alias="roleIds")
+    user: Optional[GroupMemberLimitedUser] = None
+    user_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("userId", "user_id"), serialization_alias="userId", 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"]})
+    visibility: Optional[StrictStr] = Field(default=None, json_schema_extra={"examples": ["visible"]})
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "accepted_by_display_name": "str",
+        "accepted_by_id": "str",
+        "banned_at": "datetime",
+        "created_at": "datetime",
+        "group_id": "str",
+        "has_joined_from_purchase": "bool",
+        "id": "str",
+        "is_representing": "bool",
+        "is_subscribed_to_announcements": "bool",
+        "is_subscribed_to_event_announcements": "bool",
+        "joined_at": "datetime",
+        "last_post_read_at": "datetime",
+        "m_role_ids": "List[str]",
+        "manager_notes": "str",
+        "membership_status": "GroupMemberStatus",
+        "role_ids": "List[str]",
+        "user": "GroupMemberLimitedUser",
+        "user_id": "str",
+        "visibility": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "accepted_by_display_name": "acceptedByDisplayName",
+        "accepted_by_id": "acceptedById",
+        "banned_at": "bannedAt",
+        "created_at": "createdAt",
+        "group_id": "groupId",
+        "has_joined_from_purchase": "hasJoinedFromPurchase",
+        "id": "id",
+        "is_representing": "isRepresenting",
+        "is_subscribed_to_announcements": "isSubscribedToAnnouncements",
+        "is_subscribed_to_event_announcements": "isSubscribedToEventAnnouncements",
+        "joined_at": "joinedAt",
+        "last_post_read_at": "lastPostReadAt",
+        "m_role_ids": "mRoleIds",
+        "manager_notes": "managerNotes",
+        "membership_status": "membershipStatus",
+        "role_ids": "roleIds",
+        "user": "user",
+        "user_id": "userId",
+        "visibility": "visibility"
+    }
+    __properties: ClassVar[List[str]] = ["acceptedByDisplayName", "acceptedById", "bannedAt", "createdAt", "groupId", "hasJoinedFromPurchase", "id", "isRepresenting", "isSubscribedToAnnouncements", "isSubscribedToEventAnnouncements", "joinedAt", "lastPostReadAt", "mRoleIds", "managerNotes", "membershipStatus", "roleIds", "user", "userId", "visibility"]
+
+    @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 "acceptedByDisplayName" not in obj and "accepted_by_display_name" in obj:
+            obj["acceptedByDisplayName"] = obj["accepted_by_display_name"]
+        obj.pop("accepted_by_display_name", None)
+        if "acceptedById" not in obj and "accepted_by_id" in obj:
+            obj["acceptedById"] = obj["accepted_by_id"]
+        obj.pop("accepted_by_id", None)
+        if "bannedAt" not in obj and "banned_at" in obj:
+            obj["bannedAt"] = obj["banned_at"]
+        obj.pop("banned_at", 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 "hasJoinedFromPurchase" not in obj and "has_joined_from_purchase" in obj:
+            obj["hasJoinedFromPurchase"] = obj["has_joined_from_purchase"]
+        obj.pop("has_joined_from_purchase", None)
+        if "isRepresenting" not in obj and "is_representing" in obj:
+            obj["isRepresenting"] = obj["is_representing"]
+        obj.pop("is_representing", None)
+        if "isSubscribedToAnnouncements" not in obj and "is_subscribed_to_announcements" in obj:
+            obj["isSubscribedToAnnouncements"] = obj["is_subscribed_to_announcements"]
+        obj.pop("is_subscribed_to_announcements", None)
+        if "isSubscribedToEventAnnouncements" not in obj and "is_subscribed_to_event_announcements" in obj:
+            obj["isSubscribedToEventAnnouncements"] = obj["is_subscribed_to_event_announcements"]
+        obj.pop("is_subscribed_to_event_announcements", None)
+        if "joinedAt" not in obj and "joined_at" in obj:
+            obj["joinedAt"] = obj["joined_at"]
+        obj.pop("joined_at", None)
+        if "lastPostReadAt" not in obj and "last_post_read_at" in obj:
+            obj["lastPostReadAt"] = obj["last_post_read_at"]
+        obj.pop("last_post_read_at", None)
+        if "mRoleIds" not in obj and "m_role_ids" in obj:
+            obj["mRoleIds"] = obj["m_role_ids"]
+        obj.pop("m_role_ids", None)
+        if "managerNotes" not in obj and "manager_notes" in obj:
+            obj["managerNotes"] = obj["manager_notes"]
+        obj.pop("manager_notes", None)
+        if "membershipStatus" not in obj and "membership_status" in obj:
+            obj["membershipStatus"] = obj["membership_status"]
+        obj.pop("membership_status", None)
+        if "roleIds" not in obj and "role_ids" in obj:
+            obj["roleIds"] = obj["role_ids"]
+        obj.pop("role_ids", None)
+        if "userId" not in obj and "user_id" in obj:
+            obj["userId"] = obj["user_id"]
+        obj.pop("user_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, GroupMember):
+            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, GroupMember):
+            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 GroupMember 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 {
+            ("acceptedByDisplayName" if serialize else "accepted_by_display_name"): _to_legacy_value(getattr(self, "accepted_by_display_name", None), serialize),
+            ("acceptedById" if serialize else "accepted_by_id"): _to_legacy_value(getattr(self, "accepted_by_id", None), serialize),
+            ("bannedAt" if serialize else "banned_at"): _to_legacy_value(getattr(self, "banned_at", 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),
+            ("hasJoinedFromPurchase" if serialize else "has_joined_from_purchase"): _to_legacy_value(getattr(self, "has_joined_from_purchase", None), serialize),
+            ("id" if serialize else "id"): _to_legacy_value(getattr(self, "id", None), serialize),
+            ("isRepresenting" if serialize else "is_representing"): _to_legacy_value(getattr(self, "is_representing", None), serialize),
+            ("isSubscribedToAnnouncements" if serialize else "is_subscribed_to_announcements"): _to_legacy_value(getattr(self, "is_subscribed_to_announcements", None), serialize),
+            ("isSubscribedToEventAnnouncements" if serialize else "is_subscribed_to_event_announcements"): _to_legacy_value(getattr(self, "is_subscribed_to_event_announcements", None), serialize),
+            ("joinedAt" if serialize else "joined_at"): _to_legacy_value(getattr(self, "joined_at", None), serialize),
+            ("lastPostReadAt" if serialize else "last_post_read_at"): _to_legacy_value(getattr(self, "last_post_read_at", None), serialize),
+            ("mRoleIds" if serialize else "m_role_ids"): _to_legacy_value(getattr(self, "m_role_ids", None), serialize),
+            ("managerNotes" if serialize else "manager_notes"): _to_legacy_value(getattr(self, "manager_notes", None), serialize),
+            ("membershipStatus" if serialize else "membership_status"): _to_legacy_value(getattr(self, "membership_status", None), serialize),
+            ("roleIds" if serialize else "role_ids"): _to_legacy_value(getattr(self, "role_ids", None), serialize),
+            ("user" if serialize else "user"): _to_legacy_value(getattr(self, "user", None), serialize),
+            ("userId" if serialize else "user_id"): _to_legacy_value(getattr(self, "user_id", None), serialize),
+            ("visibility" if serialize else "visibility"): _to_legacy_value(getattr(self, "visibility", 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 user
+        if self.user:
+            _dict['user'] = _to_openapi_value(self.user)
+        # set to None if accepted_by_display_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.accepted_by_display_name is None and "accepted_by_display_name" in self.model_fields_set:
+            _dict['acceptedByDisplayName'] = None
+
+        # set to None if accepted_by_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.accepted_by_id is None and "accepted_by_id" in self.model_fields_set:
+            _dict['acceptedById'] = None
+
+        # set to None if banned_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.banned_at is None and "banned_at" in self.model_fields_set:
+            _dict['bannedAt'] = None
+
+        # 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 joined_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.joined_at is None and "joined_at" in self.model_fields_set:
+            _dict['joinedAt'] = None
+
+        # set to None if last_post_read_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_post_read_at is None and "last_post_read_at" in self.model_fields_set:
+            _dict['lastPostReadAt'] = None
+
+        # set to None if manager_notes (nullable) is None
+        # and model_fields_set contains the field
+        if self.manager_notes is None and "manager_notes" in self.model_fields_set:
+            _dict['managerNotes'] = None
+
+        # set to None if user (nullable) is None
+        # and model_fields_set contains the field
+        if self.user is None and "user" in self.model_fields_set:
+            _dict['user'] = 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 GroupMember 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({
+            "acceptedByDisplayName": obj.get("acceptedByDisplayName"),
+            "acceptedById": obj.get("acceptedById"),
+            "bannedAt": obj.get("bannedAt"),
+            "createdAt": obj.get("createdAt"),
+            "groupId": obj.get("groupId"),
+            "hasJoinedFromPurchase": obj.get("hasJoinedFromPurchase"),
+            "id": obj.get("id"),
+            "isRepresenting": obj.get("isRepresenting") if obj.get("isRepresenting") is not None else False,
+            "isSubscribedToAnnouncements": obj.get("isSubscribedToAnnouncements") if obj.get("isSubscribedToAnnouncements") is not None else False,
+            "isSubscribedToEventAnnouncements": obj.get("isSubscribedToEventAnnouncements"),
+            "joinedAt": obj.get("joinedAt"),
+            "lastPostReadAt": obj.get("lastPostReadAt"),
+            "mRoleIds": obj.get("mRoleIds"),
+            "managerNotes": obj.get("managerNotes"),
+            "membershipStatus": obj.get("membershipStatus") if obj.get("membershipStatus") is not None else GroupMemberStatus.INACTIVE,
+            "roleIds": obj.get("roleIds"),
+            "user": GroupMemberLimitedUser.from_dict(obj["user"]) if obj.get("user") is not None else None,
+            "userId": obj.get("userId"),
+            "visibility": obj.get("visibility")
+        })
+        return _obj
+
+