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

vrchatapi/models/create_group_post_request.py

@@ -0,0 +1,267 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from typing_extensions import Annotated
+from vrchatapi.models.group_post_visibility import GroupPostVisibility
+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 CreateGroupPostRequest(BaseModel):
+    """
+    CreateGroupPostRequest
+
+    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
+    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"]})
+    role_ids: Optional[List[StrictStr]] = Field(default=None, validation_alias=AliasChoices("roleIds", "role_ids"), serialization_alias="roleIds", description=" ")
+    send_notification: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("sendNotification", "send_notification"), serialization_alias="sendNotification", description="Send notification to group members.", json_schema_extra={"examples": [False]})
+    text: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="Post text", json_schema_extra={"examples": ["Come join us for the event!"]})
+    title: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="Post title", json_schema_extra={"examples": ["Event is starting soon!"]})
+    visibility: Optional[GroupPostVisibility] = None
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "image_id": "str",
+        "role_ids": "List[str]",
+        "send_notification": "bool",
+        "text": "str",
+        "title": "str",
+        "visibility": "GroupPostVisibility"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "image_id": "imageId",
+        "role_ids": "roleIds",
+        "send_notification": "sendNotification",
+        "text": "text",
+        "title": "title",
+        "visibility": "visibility"
+    }
+    __properties: ClassVar[List[str]] = ["imageId", "roleIds", "sendNotification", "text", "title", "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 "imageId" not in obj and "image_id" in obj:
+            obj["imageId"] = obj["image_id"]
+        obj.pop("image_id", None)
+        if "roleIds" not in obj and "role_ids" in obj:
+            obj["roleIds"] = obj["role_ids"]
+        obj.pop("role_ids", None)
+        if "sendNotification" not in obj and "send_notification" in obj:
+            obj["sendNotification"] = obj["send_notification"]
+        obj.pop("send_notification", 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, CreateGroupPostRequest):
+            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, CreateGroupPostRequest):
+            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 CreateGroupPostRequest 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 {
+            ("imageId" if serialize else "image_id"): _to_legacy_value(getattr(self, "image_id", None), serialize),
+            ("roleIds" if serialize else "role_ids"): _to_legacy_value(getattr(self, "role_ids", None), serialize),
+            ("sendNotification" if serialize else "send_notification"): _to_legacy_value(getattr(self, "send_notification", 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),
+            ("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,
+        )
+        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 CreateGroupPostRequest 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({
+            "imageId": obj.get("imageId"),
+            "roleIds": obj.get("roleIds"),
+            "sendNotification": obj.get("sendNotification") if obj.get("sendNotification") is not None else False,
+            "text": obj.get("text"),
+            "title": obj.get("title"),
+            "visibility": obj.get("visibility")
+        })
+        return _obj
+
+

vrchatapi/models/create_group_request.py

@@ -0,0 +1,295 @@
+# 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.group_join_state import GroupJoinState
+from vrchatapi.models.group_privacy import GroupPrivacy
+from vrchatapi.models.group_role_template import GroupRoleTemplate
+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 CreateGroupRequest(BaseModel):
+    """
+    CreateGroupRequest
+
+    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
+    banner_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("bannerId", "banner_id"), serialization_alias="bannerId")
+    description: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=250)]] = None
+    icon_id: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("iconId", "icon_id"), serialization_alias="iconId")
+    join_state: Optional[GroupJoinState] = Field(default=GroupJoinState.OPEN, validation_alias=AliasChoices("joinState", "join_state"), serialization_alias="joinState")
+    name: Optional[Annotated[str, Field(min_length=3, strict=True, max_length=64)]] = None
+    privacy: Optional[GroupPrivacy] = GroupPrivacy.DEFAULT
+    role_template: Optional[GroupRoleTemplate] = Field(default=None, validation_alias=AliasChoices("roleTemplate", "role_template"), serialization_alias="roleTemplate")
+    short_code: Optional[Annotated[str, Field(min_length=3, strict=True, max_length=6)]] = Field(default=None, validation_alias=AliasChoices("shortCode", "short_code"), serialization_alias="shortCode")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "banner_id": "str",
+        "description": "str",
+        "icon_id": "str",
+        "join_state": "GroupJoinState",
+        "name": "str",
+        "privacy": "GroupPrivacy",
+        "role_template": "GroupRoleTemplate",
+        "short_code": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "banner_id": "bannerId",
+        "description": "description",
+        "icon_id": "iconId",
+        "join_state": "joinState",
+        "name": "name",
+        "privacy": "privacy",
+        "role_template": "roleTemplate",
+        "short_code": "shortCode"
+    }
+    __properties: ClassVar[List[str]] = ["bannerId", "description", "iconId", "joinState", "name", "privacy", "roleTemplate", "shortCode"]
+
+    @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 "bannerId" not in obj and "banner_id" in obj:
+            obj["bannerId"] = obj["banner_id"]
+        obj.pop("banner_id", None)
+        if "iconId" not in obj and "icon_id" in obj:
+            obj["iconId"] = obj["icon_id"]
+        obj.pop("icon_id", None)
+        if "joinState" not in obj and "join_state" in obj:
+            obj["joinState"] = obj["join_state"]
+        obj.pop("join_state", None)
+        if "roleTemplate" not in obj and "role_template" in obj:
+            obj["roleTemplate"] = obj["role_template"]
+        obj.pop("role_template", None)
+        if "shortCode" not in obj and "short_code" in obj:
+            obj["shortCode"] = obj["short_code"]
+        obj.pop("short_code", 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, CreateGroupRequest):
+            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, CreateGroupRequest):
+            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 CreateGroupRequest 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 {
+            ("bannerId" if serialize else "banner_id"): _to_legacy_value(getattr(self, "banner_id", None), serialize),
+            ("description" if serialize else "description"): _to_legacy_value(getattr(self, "description", None), serialize),
+            ("iconId" if serialize else "icon_id"): _to_legacy_value(getattr(self, "icon_id", None), serialize),
+            ("joinState" if serialize else "join_state"): _to_legacy_value(getattr(self, "join_state", None), serialize),
+            ("name" if serialize else "name"): _to_legacy_value(getattr(self, "name", None), serialize),
+            ("privacy" if serialize else "privacy"): _to_legacy_value(getattr(self, "privacy", None), serialize),
+            ("roleTemplate" if serialize else "role_template"): _to_legacy_value(getattr(self, "role_template", None), serialize),
+            ("shortCode" if serialize else "short_code"): _to_legacy_value(getattr(self, "short_code", 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 banner_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.banner_id is None and "banner_id" in self.model_fields_set:
+            _dict['bannerId'] = None
+
+        # set to None if icon_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.icon_id is None and "icon_id" in self.model_fields_set:
+            _dict['iconId'] = 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 CreateGroupRequest 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({
+            "bannerId": obj.get("bannerId"),
+            "description": obj.get("description"),
+            "iconId": obj.get("iconId"),
+            "joinState": obj.get("joinState") if obj.get("joinState") is not None else GroupJoinState.OPEN,
+            "name": obj.get("name"),
+            "privacy": obj.get("privacy") if obj.get("privacy") is not None else GroupPrivacy.DEFAULT,
+            "roleTemplate": obj.get("roleTemplate") if obj.get("roleTemplate") is not None else GroupRoleTemplate.DEFAULT,
+            "shortCode": obj.get("shortCode")
+        })
+        return _obj
+
+