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

vrchatapi/models/calendar_event_discovery.py

@@ -0,0 +1,247 @@
+# 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, cast as _cast
+from vrchatapi.models.calendar_event import CalendarEvent
+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 CalendarEventDiscovery(BaseModel):
+    """
+    CalendarEventDiscovery
+
+    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
+    next_cursor: Optional[StrictStr] = Field(default=None, validation_alias=AliasChoices("nextCursor", "next_cursor"), serialization_alias="nextCursor", description="Base64-encoded JSON:   type: object   properties:     dataSource:       type: string       enum:         - featured         - personalized     dataIndex:       type: integer       format: int32     phase:       type: string       enum:         - all         - live         - upcoming       description: see CalendarEventDiscoveryScope     asOf:       type: integer       format: int64       description: milliseconds since Unix epoch     paramHash:       type: string       format: string       description: Base64-encoded 256-bit hash of the original query parameters")
+    results: Optional[List[CalendarEvent]] = None
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "next_cursor": "str",
+        "results": "List[CalendarEvent]"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "next_cursor": "nextCursor",
+        "results": "results"
+    }
+    __properties: ClassVar[List[str]] = ["nextCursor", "results"]
+
+    @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 "nextCursor" not in obj and "next_cursor" in obj:
+            obj["nextCursor"] = obj["next_cursor"]
+        obj.pop("next_cursor", 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, CalendarEventDiscovery):
+            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, CalendarEventDiscovery):
+            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 CalendarEventDiscovery 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 {
+            ("nextCursor" if serialize else "next_cursor"): _to_legacy_value(getattr(self, "next_cursor", None), serialize),
+            ("results" if serialize else "results"): _to_legacy_value(getattr(self, "results", 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 each item in results (list)
+        _items = []
+        if self.results:
+            for _item_results in self.results:
+                if _item_results:
+                    _items.append(_to_openapi_value(_item_results))
+            _dict['results'] = _items
+        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 CalendarEventDiscovery 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({
+            "nextCursor": obj.get("nextCursor"),
+            "results": [CalendarEvent.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None
+        })
+        return _obj
+
+

vrchatapi/models/calendar_event_discovery_inclusion.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class CalendarEventDiscoveryInclusion(str, Enum):
+    """
+    CalendarEventDiscoveryInclusion
+    """
+
+    """
+    allowed enum values
+    """
+    EXCLUDE = 'exclude'
+    INCLUDE = 'include'
+    SKIP = 'skip'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CalendarEventDiscoveryInclusion from a JSON string"""
+        return cls(json.loads(json_str))
+
+

vrchatapi/models/calendar_event_discovery_scope.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class CalendarEventDiscoveryScope(str, Enum):
+    """
+    CalendarEventDiscoveryScope
+    """
+
+    """
+    allowed enum values
+    """
+    ALL = 'all'
+    LIVE = 'live'
+    UPCOMING = 'upcoming'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CalendarEventDiscoveryScope from a JSON string"""
+        return cls(json.loads(json_str))
+
+

vrchatapi/models/calendar_event_frequency.py

@@ -0,0 +1,39 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class CalendarEventFrequency(str, Enum):
+    """
+    The time unit used to specify how often a recurring event occurs.
+    """
+
+    """
+    allowed enum values
+    """
+    DAILY = 'daily'
+    MONTHLY = 'monthly'
+    WEEKLY = 'weekly'
+    YEARLY = 'yearly'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CalendarEventFrequency from a JSON string"""
+        return cls(json.loads(json_str))
+
+

vrchatapi/models/calendar_event_occurrence_kind.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class CalendarEventOccurrenceKind(str, Enum):
+    """
+    How an event occurs or recurs. \"single\" is a standalone event, \"series\" is a parent specification of a recurring series, and \"occurrence\" is an individual event in a series.
+    """
+
+    """
+    allowed enum values
+    """
+    OCCURRENCE = 'occurrence'
+    SERIES = 'series'
+    SINGLE = 'single'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CalendarEventOccurrenceKind from a JSON string"""
+        return cls(json.loads(json_str))
+
+

vrchatapi/models/calendar_event_platform.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class CalendarEventPlatform(str, Enum):
+    """
+    CalendarEventPlatform
+    """
+
+    """
+    allowed enum values
+    """
+    ANDROID = 'android'
+    IOS = 'ios'
+    STANDALONEWINDOWS = 'standalonewindows'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CalendarEventPlatform from a JSON string"""
+        return cls(json.loads(json_str))
+
+

vrchatapi/models/calendar_event_recurrence.py

@@ -0,0 +1,261 @@
+# 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.calendar_day_of_week import CalendarDayOfWeek
+from vrchatapi.models.calendar_event_frequency import CalendarEventFrequency
+from vrchatapi.models.calendar_event_recurrence_end import CalendarEventRecurrenceEnd
+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 CalendarEventRecurrence(BaseModel):
+    """
+    Details about how a recurring event will be scheduled. If the event is to be scheduled indefinitely, this will lack an \"end\" property.
+
+    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
+    days_of_week: Optional[List[CalendarDayOfWeek]] = Field(default=None, validation_alias=AliasChoices("daysOfWeek", "days_of_week"), serialization_alias="daysOfWeek", description="Which days of the week the event will be scheduled, only valid/present for \"weekly\" recurring events")
+    end: Optional[CalendarEventRecurrenceEnd] = None
+    frequency: Optional[CalendarEventFrequency] = None
+    interval: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="How often the event will be scheduled, in units of \"frequency\"")
+    timezone: Optional[StrictStr] = Field(default=None, description="The timezone the event will be scheduled in, in Area/Location format", json_schema_extra={"examples": ["America/Chicago"]})
+    openapi_types: ClassVar[Dict[str, str]] = {
+        "days_of_week": "List[CalendarDayOfWeek]",
+        "end": "CalendarEventRecurrenceEnd",
+        "frequency": "CalendarEventFrequency",
+        "interval": "int",
+        "timezone": "str"
+    }
+
+    attribute_map: ClassVar[Dict[str, str]] = {
+        "days_of_week": "daysOfWeek",
+        "end": "end",
+        "frequency": "frequency",
+        "interval": "interval",
+        "timezone": "timezone"
+    }
+    __properties: ClassVar[List[str]] = ["daysOfWeek", "end", "frequency", "interval", "timezone"]
+
+    @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 "daysOfWeek" not in obj and "days_of_week" in obj:
+            obj["daysOfWeek"] = obj["days_of_week"]
+        obj.pop("days_of_week", 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, CalendarEventRecurrence):
+            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, CalendarEventRecurrence):
+            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 CalendarEventRecurrence 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 {
+            ("daysOfWeek" if serialize else "days_of_week"): _to_legacy_value(getattr(self, "days_of_week", None), serialize),
+            ("end" if serialize else "end"): _to_legacy_value(getattr(self, "end", None), serialize),
+            ("frequency" if serialize else "frequency"): _to_legacy_value(getattr(self, "frequency", None), serialize),
+            ("interval" if serialize else "interval"): _to_legacy_value(getattr(self, "interval", None), serialize),
+            ("timezone" if serialize else "timezone"): _to_legacy_value(getattr(self, "timezone", 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 end
+        if self.end:
+            _dict['end'] = _to_openapi_value(self.end)
+        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 CalendarEventRecurrence 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({
+            "daysOfWeek": obj.get("daysOfWeek"),
+            "end": CalendarEventRecurrenceEnd.from_dict(obj["end"]) if obj.get("end") is not None else None,
+            "frequency": obj.get("frequency") if obj.get("frequency") is not None else CalendarEventFrequency.WEEKLY,
+            "interval": obj.get("interval"),
+            "timezone": obj.get("timezone")
+        })
+        return _obj
+
+