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

vrchatapi/models/websocket_notification_detail_boop.py

@@ -0,0 +1,364 @@
+# 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 WebsocketNotificationDetailBoop(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 = {
+        'details': 'NotificationDetailBoop',
+        'type': 'str',
+        'created_at': 'datetime',
+        'id': 'str',
+        'message': 'str',
+        'receiver_user_id': 'str',
+        'seen': 'bool',
+        'sender_user_id': 'str',
+        'sender_username': 'str'
+    }
+
+    attribute_map = {
+        'details': 'details',
+        'type': 'type',
+        'created_at': 'created_at',
+        'id': 'id',
+        'message': 'message',
+        'receiver_user_id': 'receiverUserId',
+        'seen': 'seen',
+        'sender_user_id': 'senderUserId',
+        'sender_username': 'senderUsername'
+    }
+
+    def __init__(self, details=None, type=None, created_at=None, id=None, message=None, receiver_user_id=None, seen=False, sender_user_id=None, sender_username=None, local_vars_configuration=None):  # noqa: E501
+        """WebsocketNotificationDetailBoop - 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._details = None
+        self._type = None
+        self._created_at = None
+        self._id = None
+        self._message = None
+        self._receiver_user_id = None
+        self._seen = None
+        self._sender_user_id = None
+        self._sender_username = None
+        self.discriminator = None
+
+        self.details = details
+        self.type = type
+        self.created_at = created_at
+        self.id = id
+        self.message = message
+        if receiver_user_id is not None:
+            self.receiver_user_id = receiver_user_id
+        if seen is not None:
+            self.seen = seen
+        self.sender_user_id = sender_user_id
+        self.sender_username = sender_username
+
+    @property
+    def details(self):
+        """Gets the details of this WebsocketNotificationDetailBoop.  # noqa: E501
+
+
+        :return: The details of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: NotificationDetailBoop
+        """
+        return self._details
+
+    @details.setter
+    def details(self, details):
+        """Sets the details of this WebsocketNotificationDetailBoop.
+
+
+        :param details: The details of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type details: NotificationDetailBoop
+        """
+        if self.local_vars_configuration.client_side_validation and details is None:  # noqa: E501
+            raise ValueError("Invalid value for `details`, must not be `None`")  # noqa: E501
+
+        self._details = details
+
+    @property
+    def type(self):
+        """Gets the type of this WebsocketNotificationDetailBoop.  # noqa: E501
+
+
+        :return: The type of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this WebsocketNotificationDetailBoop.
+
+
+        :param type: The type of this WebsocketNotificationDetailBoop.  # 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 = ["boop"]  # 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
+
+    @property
+    def created_at(self):
+        """Gets the created_at of this WebsocketNotificationDetailBoop.  # noqa: E501
+
+
+        :return: The created_at of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._created_at
+
+    @created_at.setter
+    def created_at(self, created_at):
+        """Sets the created_at of this WebsocketNotificationDetailBoop.
+
+
+        :param created_at: The created_at of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type created_at: datetime
+        """
+        if self.local_vars_configuration.client_side_validation and created_at is None:  # noqa: E501
+            raise ValueError("Invalid value for `created_at`, must not be `None`")  # noqa: E501
+
+        self._created_at = created_at
+
+    @property
+    def id(self):
+        """Gets the id of this WebsocketNotificationDetailBoop.  # noqa: E501
+
+
+        :return: The id of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this WebsocketNotificationDetailBoop.
+
+
+        :param id: The id of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type id: str
+        """
+        if self.local_vars_configuration.client_side_validation and id is None:  # noqa: E501
+            raise ValueError("Invalid value for `id`, must not be `None`")  # noqa: E501
+        if (self.local_vars_configuration.client_side_validation and
+                id is not None and len(id) < 1):
+            raise ValueError("Invalid value for `id`, length must be greater than or equal to `1`")  # noqa: E501
+
+        self._id = id
+
+    @property
+    def message(self):
+        """Gets the message of this WebsocketNotificationDetailBoop.  # noqa: E501
+
+
+        :return: The message of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: str
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message):
+        """Sets the message of this WebsocketNotificationDetailBoop.
+
+
+        :param message: The message of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type message: str
+        """
+        if self.local_vars_configuration.client_side_validation and message is None:  # noqa: E501
+            raise ValueError("Invalid value for `message`, must not be `None`")  # noqa: E501
+
+        self._message = message
+
+    @property
+    def receiver_user_id(self):
+        """Gets the receiver_user_id of this WebsocketNotificationDetailBoop.  # 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 receiver_user_id of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: str
+        """
+        return self._receiver_user_id
+
+    @receiver_user_id.setter
+    def receiver_user_id(self, receiver_user_id):
+        """Sets the receiver_user_id of this WebsocketNotificationDetailBoop.
+
+        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 receiver_user_id: The receiver_user_id of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type receiver_user_id: str
+        """
+
+        self._receiver_user_id = receiver_user_id
+
+    @property
+    def seen(self):
+        """Gets the seen of this WebsocketNotificationDetailBoop.  # noqa: E501
+
+        Not included in notification objects received from the Websocket API  # noqa: E501
+
+        :return: The seen of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: bool
+        """
+        return self._seen
+
+    @seen.setter
+    def seen(self, seen):
+        """Sets the seen of this WebsocketNotificationDetailBoop.
+
+        Not included in notification objects received from the Websocket API  # noqa: E501
+
+        :param seen: The seen of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type seen: bool
+        """
+
+        self._seen = seen
+
+    @property
+    def sender_user_id(self):
+        """Gets the sender_user_id of this WebsocketNotificationDetailBoop.  # 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 sender_user_id of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: str
+        """
+        return self._sender_user_id
+
+    @sender_user_id.setter
+    def sender_user_id(self, sender_user_id):
+        """Sets the sender_user_id of this WebsocketNotificationDetailBoop.
+
+        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 sender_user_id: The sender_user_id of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type sender_user_id: str
+        """
+        if self.local_vars_configuration.client_side_validation and sender_user_id is None:  # noqa: E501
+            raise ValueError("Invalid value for `sender_user_id`, must not be `None`")  # noqa: E501
+
+        self._sender_user_id = sender_user_id
+
+    @property
+    def sender_username(self):
+        """Gets the sender_username of this WebsocketNotificationDetailBoop.  # noqa: E501
+
+        The name of the user who sent the notification.  # noqa: E501
+
+        :return: The sender_username of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :rtype: str
+        """
+        return self._sender_username
+
+    @sender_username.setter
+    def sender_username(self, sender_username):
+        """Sets the sender_username of this WebsocketNotificationDetailBoop.
+
+        The name of the user who sent the notification.  # noqa: E501
+
+        :param sender_username: The sender_username of this WebsocketNotificationDetailBoop.  # noqa: E501
+        :type sender_username: str
+        """
+        if (self.local_vars_configuration.client_side_validation and
+                sender_username is not None and len(sender_username) < 1):
+            raise ValueError("Invalid value for `sender_username`, length must be greater than or equal to `1`")  # noqa: E501
+
+        self._sender_username = sender_username
+
+    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, WebsocketNotificationDetailBoop):
+            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, WebsocketNotificationDetailBoop):
+            return True
+
+        return self.to_dict() != other.to_dict()