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

vrchatapi/models/info_push.py

@@ -0,0 +1,306 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, cast as _cast
+from typing_extensions import Annotated
+from vrchatapi.models.info_push_data import InfoPushData
+from vrchatapi.models.release_status import ReleaseStatus
+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 InfoPush(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
+    created_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("createdAt", "created_at"), serialization_alias="createdAt")
+    data: Optional[InfoPushData] = None
+    end_date: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("endDate", "end_date"), serialization_alias="endDate")
+    hash: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="Unknown usage, MD5")
+    id: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, json_schema_extra={"examples": ["launch-beta"]})
+    is_enabled: Optional[StrictBool] = Field(default=None, validation_alias=AliasChoices("isEnabled", "is_enabled"), serialization_alias="isEnabled")
+    priority: Optional[StrictInt] = None
+    release_status: Optional[ReleaseStatus] = Field(default=None, validation_alias=AliasChoices("releaseStatus", "release_status"), serialization_alias="releaseStatus")
+    start_date: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("startDate", "start_date"), serialization_alias="startDate")
+    tags: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = Field(default=None, description=" ")
+    updated_at: Optional[datetime] = Field(default=None, validation_alias=AliasChoices("updatedAt", "updated_at"), serialization_alias="updatedAt")
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "created_at": "datetime",
+        "data": "InfoPushData",
+        "end_date": "datetime",
+        "hash": "str",
+        "id": "str",
+        "is_enabled": "bool",
+        "priority": "int",
+        "release_status": "ReleaseStatus",
+        "start_date": "datetime",
+        "tags": "List[str]",
+        "updated_at": "datetime"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "created_at": "createdAt",
+        "data": "data",
+        "end_date": "endDate",
+        "hash": "hash",
+        "id": "id",
+        "is_enabled": "isEnabled",
+        "priority": "priority",
+        "release_status": "releaseStatus",
+        "start_date": "startDate",
+        "tags": "tags",
+        "updated_at": "updatedAt"
+    }
+    __properties: ClassVar[List[str]] = ["createdAt", "data", "endDate", "hash", "id", "isEnabled", "priority", "releaseStatus", "startDate", "tags", "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 "createdAt" not in obj and "created_at" in obj:
+            obj["createdAt"] = obj["created_at"]
+        obj.pop("created_at", None)
+        if "endDate" not in obj and "end_date" in obj:
+            obj["endDate"] = obj["end_date"]
+        obj.pop("end_date", None)
+        if "isEnabled" not in obj and "is_enabled" in obj:
+            obj["isEnabled"] = obj["is_enabled"]
+        obj.pop("is_enabled", None)
+        if "releaseStatus" not in obj and "release_status" in obj:
+            obj["releaseStatus"] = obj["release_status"]
+        obj.pop("release_status", None)
+        if "startDate" not in obj and "start_date" in obj:
+            obj["startDate"] = obj["start_date"]
+        obj.pop("start_date", 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, InfoPush):
+            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, InfoPush):
+            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 InfoPush 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 {
+            ("createdAt" 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),
+            ("endDate" if serialize else "end_date"): _to_legacy_value(getattr(self, "end_date", None), serialize),
+            ("hash" if serialize else "hash"): _to_legacy_value(getattr(self, "hash", None), serialize),
+            ("id" if serialize else "id"): _to_legacy_value(getattr(self, "id", None), serialize),
+            ("isEnabled" if serialize else "is_enabled"): _to_legacy_value(getattr(self, "is_enabled", None), serialize),
+            ("priority" if serialize else "priority"): _to_legacy_value(getattr(self, "priority", None), serialize),
+            ("releaseStatus" if serialize else "release_status"): _to_legacy_value(getattr(self, "release_status", None), serialize),
+            ("startDate" if serialize else "start_date"): _to_legacy_value(getattr(self, "start_date", None), serialize),
+            ("tags" if serialize else "tags"): _to_legacy_value(getattr(self, "tags", 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,
+        )
+        # 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 InfoPush 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({
+            "createdAt": obj.get("createdAt"),
+            "data": InfoPushData.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "endDate": obj.get("endDate"),
+            "hash": obj.get("hash"),
+            "id": obj.get("id"),
+            "isEnabled": obj.get("isEnabled") if obj.get("isEnabled") is not None else True,
+            "priority": obj.get("priority"),
+            "releaseStatus": obj.get("releaseStatus") if obj.get("releaseStatus") is not None else ReleaseStatus.PUBLIC,
+            "startDate": obj.get("startDate"),
+            "tags": obj.get("tags"),
+            "updatedAt": obj.get("updatedAt")
+        })
+        return _obj
+
+

vrchatapi/models/info_push_data.py

@@ -0,0 +1,288 @@
+# 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.dynamic_content_row import DynamicContentRow
+from vrchatapi.models.info_push_data_article import InfoPushDataArticle
+from vrchatapi.models.info_push_data_clickable import InfoPushDataClickable
+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 InfoPushData(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
+    article: Optional[InfoPushDataArticle] = None
+    content_list: Optional[DynamicContentRow] = Field(default=None, validation_alias=AliasChoices("contentList", "content_list"), serialization_alias="contentList")
+    description: Optional[StrictStr] = None
+    image_url: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, validation_alias=AliasChoices("imageUrl", "image_url"), serialization_alias="imageUrl")
+    name: Optional[StrictStr] = None
+    on_pressed: Optional[InfoPushDataClickable] = Field(default=None, validation_alias=AliasChoices("onPressed", "on_pressed"), serialization_alias="onPressed")
+    template: Optional[StrictStr] = None
+    version: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, json_schema_extra={"examples": ["2021.3.4"]})
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "article": "InfoPushDataArticle",
+        "content_list": "DynamicContentRow",
+        "description": "str",
+        "image_url": "str",
+        "name": "str",
+        "on_pressed": "InfoPushDataClickable",
+        "template": "str",
+        "version": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "article": "article",
+        "content_list": "contentList",
+        "description": "description",
+        "image_url": "imageUrl",
+        "name": "name",
+        "on_pressed": "onPressed",
+        "template": "template",
+        "version": "version"
+    }
+    __properties: ClassVar[List[str]] = ["article", "contentList", "description", "imageUrl", "name", "onPressed", "template", "version"]
+
+    @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 "contentList" not in obj and "content_list" in obj:
+            obj["contentList"] = obj["content_list"]
+        obj.pop("content_list", None)
+        if "imageUrl" not in obj and "image_url" in obj:
+            obj["imageUrl"] = obj["image_url"]
+        obj.pop("image_url", None)
+        if "onPressed" not in obj and "on_pressed" in obj:
+            obj["onPressed"] = obj["on_pressed"]
+        obj.pop("on_pressed", 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, InfoPushData):
+            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, InfoPushData):
+            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 InfoPushData 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 {
+            ("article" if serialize else "article"): _to_legacy_value(getattr(self, "article", None), serialize),
+            ("contentList" if serialize else "content_list"): _to_legacy_value(getattr(self, "content_list", None), serialize),
+            ("description" if serialize else "description"): _to_legacy_value(getattr(self, "description", None), serialize),
+            ("imageUrl" if serialize else "image_url"): _to_legacy_value(getattr(self, "image_url", None), serialize),
+            ("name" if serialize else "name"): _to_legacy_value(getattr(self, "name", None), serialize),
+            ("onPressed" if serialize else "on_pressed"): _to_legacy_value(getattr(self, "on_pressed", None), serialize),
+            ("template" if serialize else "template"): _to_legacy_value(getattr(self, "template", None), serialize),
+            ("version" if serialize else "version"): _to_legacy_value(getattr(self, "version", 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 article
+        if self.article:
+            _dict['article'] = _to_openapi_value(self.article)
+        # override the default output from pydantic by calling `to_dict()` of content_list
+        if self.content_list:
+            _dict['contentList'] = _to_openapi_value(self.content_list)
+        # override the default output from pydantic by calling `to_dict()` of on_pressed
+        if self.on_pressed:
+            _dict['onPressed'] = _to_openapi_value(self.on_pressed)
+        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 InfoPushData 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({
+            "article": InfoPushDataArticle.from_dict(obj["article"]) if obj.get("article") is not None else None,
+            "contentList": DynamicContentRow.from_dict(obj["contentList"]) if obj.get("contentList") is not None else None,
+            "description": obj.get("description"),
+            "imageUrl": obj.get("imageUrl"),
+            "name": obj.get("name"),
+            "onPressed": InfoPushDataClickable.from_dict(obj["onPressed"]) if obj.get("onPressed") is not None else None,
+            "template": obj.get("template"),
+            "version": obj.get("version")
+        })
+        return _obj
+
+