vrchatapi 1.22.2.dev2__py3-none-any.whl → 1.22.2.dev4__py3-none-any.whl

vrchatapi/models/websocket_user_location.py

@@ -0,0 +1,248 @@
+# coding: utf-8
+
+"""
+    VRChat API
+
+    This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API.  _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._  Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself.  Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying.  **Something wrong or missing?**  The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one:  - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about.  Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly).   # noqa: E501
+
+    The version of the OpenAPI document: 1.22.2-nightly.4
+    Generated by: https://openapi-generator.tech
+"""
+
+
+try:
+    from inspect import getfullargspec
+except ImportError:
+    from inspect import getargspec as getfullargspec
+import pprint
+import re  # noqa: F401
+import six
+
+from vrchatapi.configuration import Configuration
+
+
+class WebsocketUserLocation(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    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.
+    """
+    openapi_types = {
+        'instance': 'str',
+        'location': 'str',
+        'traveling_to_location': 'str',
+        'user': 'User',
+        'user_id': 'str'
+    }
+
+    attribute_map = {
+        'instance': 'instance',
+        'location': 'location',
+        'traveling_to_location': 'travelingToLocation',
+        'user': 'user',
+        'user_id': 'userId'
+    }
+
+    def __init__(self, instance=None, location=None, traveling_to_location=None, user=None, user_id=None, local_vars_configuration=None):  # noqa: E501
+        """WebsocketUserLocation - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration.get_default_copy()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._instance = None
+        self._location = None
+        self._traveling_to_location = None
+        self._user = None
+        self._user_id = None
+        self.discriminator = None
+
+        self.instance = instance
+        self.location = location
+        self.traveling_to_location = traveling_to_location
+        self.user = user
+        self.user_id = user_id
+
+    @property
+    def instance(self):
+        """Gets the instance of this WebsocketUserLocation.  # noqa: E501
+
+        InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance.  # noqa: E501
+
+        :return: The instance of this WebsocketUserLocation.  # noqa: E501
+        :rtype: str
+        """
+        return self._instance
+
+    @instance.setter
+    def instance(self, instance):
+        """Sets the instance of this WebsocketUserLocation.
+
+        InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance.  # noqa: E501
+
+        :param instance: The instance of this WebsocketUserLocation.  # noqa: E501
+        :type instance: str
+        """
+        if self.local_vars_configuration.client_side_validation and instance is None:  # noqa: E501
+            raise ValueError("Invalid value for `instance`, must not be `None`")  # noqa: E501
+
+        self._instance = instance
+
+    @property
+    def location(self):
+        """Gets the location of this WebsocketUserLocation.  # noqa: E501
+
+        Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list.  # noqa: E501
+
+        :return: The location of this WebsocketUserLocation.  # noqa: E501
+        :rtype: str
+        """
+        return self._location
+
+    @location.setter
+    def location(self, location):
+        """Sets the location of this WebsocketUserLocation.
+
+        Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list.  # noqa: E501
+
+        :param location: The location of this WebsocketUserLocation.  # noqa: E501
+        :type location: str
+        """
+        if self.local_vars_configuration.client_side_validation and location is None:  # noqa: E501
+            raise ValueError("Invalid value for `location`, must not be `None`")  # noqa: E501
+
+        self._location = location
+
+    @property
+    def traveling_to_location(self):
+        """Gets the traveling_to_location of this WebsocketUserLocation.  # noqa: E501
+
+        Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list.  # noqa: E501
+
+        :return: The traveling_to_location of this WebsocketUserLocation.  # noqa: E501
+        :rtype: str
+        """
+        return self._traveling_to_location
+
+    @traveling_to_location.setter
+    def traveling_to_location(self, traveling_to_location):
+        """Sets the traveling_to_location of this WebsocketUserLocation.
+
+        Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list.  # noqa: E501
+
+        :param traveling_to_location: The traveling_to_location of this WebsocketUserLocation.  # noqa: E501
+        :type traveling_to_location: str
+        """
+        if self.local_vars_configuration.client_side_validation and traveling_to_location is None:  # noqa: E501
+            raise ValueError("Invalid value for `traveling_to_location`, must not be `None`")  # noqa: E501
+
+        self._traveling_to_location = traveling_to_location
+
+    @property
+    def user(self):
+        """Gets the user of this WebsocketUserLocation.  # noqa: E501
+
+
+        :return: The user of this WebsocketUserLocation.  # noqa: E501
+        :rtype: User
+        """
+        return self._user
+
+    @user.setter
+    def user(self, user):
+        """Sets the user of this WebsocketUserLocation.
+
+
+        :param user: The user of this WebsocketUserLocation.  # noqa: E501
+        :type user: User
+        """
+        if self.local_vars_configuration.client_side_validation and user is None:  # noqa: E501
+            raise ValueError("Invalid value for `user`, must not be `None`")  # noqa: E501
+
+        self._user = user
+
+    @property
+    def user_id(self):
+        """Gets the user_id of this WebsocketUserLocation.  # noqa: E501
+
+        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.  # noqa: E501
+
+        :return: The user_id of this WebsocketUserLocation.  # noqa: E501
+        :rtype: str
+        """
+        return self._user_id
+
+    @user_id.setter
+    def user_id(self, user_id):
+        """Sets the user_id of this WebsocketUserLocation.
+
+        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.  # noqa: E501
+
+        :param user_id: The user_id of this WebsocketUserLocation.  # noqa: E501
+        :type user_id: str
+        """
+        if self.local_vars_configuration.client_side_validation and user_id is None:  # noqa: E501
+            raise ValueError("Invalid value for `user_id`, must not be `None`")  # noqa: E501
+
+        self._user_id = user_id
+
+    def to_dict(self, serialize=False):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        def convert(x):
+            if hasattr(x, "to_dict"):
+                args = getfullargspec(x.to_dict).args
+                if len(args) == 1:
+                    return x.to_dict()
+                else:
+                    return x.to_dict(serialize)
+            else:
+                return x
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            attr = self.attribute_map.get(attr, attr) if serialize else attr
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: convert(x),
+                    value
+                ))
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], convert(item[1])),
+                    value.items()
+                ))
+            else:
+                result[attr] = convert(value)
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, WebsocketUserLocation):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, WebsocketUserLocation):
+            return True
+
+        return self.to_dict() != other.to_dict()

vrchatapi/models/websocket_user_location_encoded.py

@@ -0,0 +1,165 @@
+# coding: utf-8
+
+"""
+    VRChat API
+
+    This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API.  _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._  Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself.  Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying.  **Something wrong or missing?**  The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one:  - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about.  Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly).   # noqa: E501
+
+    The version of the OpenAPI document: 1.22.2-nightly.4
+    Generated by: https://openapi-generator.tech
+"""
+
+
+try:
+    from inspect import getfullargspec
+except ImportError:
+    from inspect import getargspec as getfullargspec
+import pprint
+import re  # noqa: F401
+import six
+
+from vrchatapi.configuration import Configuration
+
+
+class WebsocketUserLocationEncoded(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    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.
+    """
+    openapi_types = {
+        'content': 'str',
+        'type': 'str'
+    }
+
+    attribute_map = {
+        'content': 'content',
+        'type': 'type'
+    }
+
+    def __init__(self, content=None, type=None, local_vars_configuration=None):  # noqa: E501
+        """WebsocketUserLocationEncoded - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration.get_default_copy()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._content = None
+        self._type = None
+        self.discriminator = None
+
+        self.content = content
+        self.type = type
+
+    @property
+    def content(self):
+        """Gets the content of this WebsocketUserLocationEncoded.  # noqa: E501
+
+
+        :return: The content of this WebsocketUserLocationEncoded.  # noqa: E501
+        :rtype: str
+        """
+        return self._content
+
+    @content.setter
+    def content(self, content):
+        """Sets the content of this WebsocketUserLocationEncoded.
+
+
+        :param content: The content of this WebsocketUserLocationEncoded.  # noqa: E501
+        :type content: str
+        """
+        if self.local_vars_configuration.client_side_validation and content is None:  # noqa: E501
+            raise ValueError("Invalid value for `content`, must not be `None`")  # noqa: E501
+
+        self._content = content
+
+    @property
+    def type(self):
+        """Gets the type of this WebsocketUserLocationEncoded.  # noqa: E501
+
+
+        :return: The type of this WebsocketUserLocationEncoded.  # noqa: E501
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this WebsocketUserLocationEncoded.
+
+
+        :param type: The type of this WebsocketUserLocationEncoded.  # noqa: E501
+        :type type: str
+        """
+        if self.local_vars_configuration.client_side_validation and type is None:  # noqa: E501
+            raise ValueError("Invalid value for `type`, must not be `None`")  # noqa: E501
+        allowed_values = ["user-location"]  # noqa: E501
+        if self.local_vars_configuration.client_side_validation and type not in allowed_values:  # noqa: E501
+            raise ValueError(
+                "Invalid value for `type` ({0}), must be one of {1}"  # noqa: E501
+                .format(type, allowed_values)
+            )
+
+        self._type = type
+
+    def to_dict(self, serialize=False):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        def convert(x):
+            if hasattr(x, "to_dict"):
+                args = getfullargspec(x.to_dict).args
+                if len(args) == 1:
+                    return x.to_dict()
+                else:
+                    return x.to_dict(serialize)
+            else:
+                return x
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            attr = self.attribute_map.get(attr, attr) if serialize else attr
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: convert(x),
+                    value
+                ))
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], convert(item[1])),
+                    value.items()
+                ))
+            else:
+                result[attr] = convert(value)
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, WebsocketUserLocationEncoded):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, WebsocketUserLocationEncoded):
+            return True
+
+        return self.to_dict() != other.to_dict()

vrchatapi/models/websocket_user_update.py

@@ -0,0 +1,161 @@
+# coding: utf-8
+
+"""
+    VRChat API
+
+    This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API.  _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._  Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself.  Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying.  **Something wrong or missing?**  The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one:  - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about.  Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly).   # noqa: E501
+
+    The version of the OpenAPI document: 1.22.2-nightly.4
+    Generated by: https://openapi-generator.tech
+"""
+
+
+try:
+    from inspect import getfullargspec
+except ImportError:
+    from inspect import getargspec as getfullargspec
+import pprint
+import re  # noqa: F401
+import six
+
+from vrchatapi.configuration import Configuration
+
+
+class WebsocketUserUpdate(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    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.
+    """
+    openapi_types = {
+        'user': 'User',
+        'user_id': 'str'
+    }
+
+    attribute_map = {
+        'user': 'user',
+        'user_id': 'userId'
+    }
+
+    def __init__(self, user=None, user_id=None, local_vars_configuration=None):  # noqa: E501
+        """WebsocketUserUpdate - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration.get_default_copy()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._user = None
+        self._user_id = None
+        self.discriminator = None
+
+        self.user = user
+        self.user_id = user_id
+
+    @property
+    def user(self):
+        """Gets the user of this WebsocketUserUpdate.  # noqa: E501
+
+
+        :return: The user of this WebsocketUserUpdate.  # noqa: E501
+        :rtype: User
+        """
+        return self._user
+
+    @user.setter
+    def user(self, user):
+        """Sets the user of this WebsocketUserUpdate.
+
+
+        :param user: The user of this WebsocketUserUpdate.  # noqa: E501
+        :type user: User
+        """
+        if self.local_vars_configuration.client_side_validation and user is None:  # noqa: E501
+            raise ValueError("Invalid value for `user`, must not be `None`")  # noqa: E501
+
+        self._user = user
+
+    @property
+    def user_id(self):
+        """Gets the user_id of this WebsocketUserUpdate.  # noqa: E501
+
+        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.  # noqa: E501
+
+        :return: The user_id of this WebsocketUserUpdate.  # noqa: E501
+        :rtype: str
+        """
+        return self._user_id
+
+    @user_id.setter
+    def user_id(self, user_id):
+        """Sets the user_id of this WebsocketUserUpdate.
+
+        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.  # noqa: E501
+
+        :param user_id: The user_id of this WebsocketUserUpdate.  # noqa: E501
+        :type user_id: str
+        """
+        if self.local_vars_configuration.client_side_validation and user_id is None:  # noqa: E501
+            raise ValueError("Invalid value for `user_id`, must not be `None`")  # noqa: E501
+
+        self._user_id = user_id
+
+    def to_dict(self, serialize=False):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        def convert(x):
+            if hasattr(x, "to_dict"):
+                args = getfullargspec(x.to_dict).args
+                if len(args) == 1:
+                    return x.to_dict()
+                else:
+                    return x.to_dict(serialize)
+            else:
+                return x
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            attr = self.attribute_map.get(attr, attr) if serialize else attr
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: convert(x),
+                    value
+                ))
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], convert(item[1])),
+                    value.items()
+                ))
+            else:
+                result[attr] = convert(value)
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, WebsocketUserUpdate):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, WebsocketUserUpdate):
+            return True
+
+        return self.to_dict() != other.to_dict()