tb-rest-client 3.8.0__py3-none-any.whl

tb_rest_client/models/models_pe/alarm_comment_info.py

@@ -0,0 +1,376 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
+
+    OpenAPI spec version: 3.7.0PE
+    Contact: info@thingsboard.io
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+#  Copyright 2024. ThingsBoard
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+class AlarmCommentInfo(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+    """
+    Attributes:
+      swagger_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.
+    """
+    swagger_types = {
+        'id': 'AlarmCommentId',
+        'created_time': 'int',
+        'alarm_id': 'AlarmId',
+        'user_id': 'UserId',
+        'type': 'str',
+        'comment': 'JsonNode',
+        'first_name': 'str',
+        'last_name': 'str',
+        'email': 'str',
+        'name': 'str'
+    }
+
+    attribute_map = {
+        'id': 'id',
+        'created_time': 'createdTime',
+        'alarm_id': 'alarmId',
+        'user_id': 'userId',
+        'type': 'type',
+        'comment': 'comment',
+        'first_name': 'firstName',
+        'last_name': 'lastName',
+        'email': 'email',
+        'name': 'name'
+    }
+
+    def __init__(self, id=None, created_time=None, alarm_id=None, user_id=None, type=None, comment=None, first_name=None, last_name=None, email=None, name=None):  # noqa: E501
+        """AlarmCommentInfo - a model defined in Swagger"""  # noqa: E501
+        self._id = None
+        self._created_time = None
+        self._alarm_id = None
+        self._user_id = None
+        self._type = None
+        self._comment = None
+        self._first_name = None
+        self._last_name = None
+        self._email = None
+        self._name = None
+        self.discriminator = None
+        if id is not None:
+            self.id = id
+        if created_time is not None:
+            self.created_time = created_time
+        if alarm_id is not None:
+            self.alarm_id = alarm_id
+        if user_id is not None:
+            self.user_id = user_id
+        if type is not None:
+            self.type = type
+        if comment is not None:
+            self.comment = comment
+        if first_name is not None:
+            self.first_name = first_name
+        if last_name is not None:
+            self.last_name = last_name
+        if email is not None:
+            self.email = email
+        if name is not None:
+            self.name = name
+
+    @property
+    def id(self):
+        """Gets the id of this AlarmCommentInfo.  # noqa: E501
+
+
+        :return: The id of this AlarmCommentInfo.  # noqa: E501
+        :rtype: AlarmCommentId
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this AlarmCommentInfo.
+
+
+        :param id: The id of this AlarmCommentInfo.  # noqa: E501
+        :type: AlarmCommentId
+        """
+
+        self._id = id
+
+    @property
+    def created_time(self):
+        """Gets the created_time of this AlarmCommentInfo.  # noqa: E501
+
+        Timestamp of the alarm comment creation, in milliseconds  # noqa: E501
+
+        :return: The created_time of this AlarmCommentInfo.  # noqa: E501
+        :rtype: int
+        """
+        return self._created_time
+
+    @created_time.setter
+    def created_time(self, created_time):
+        """Sets the created_time of this AlarmCommentInfo.
+
+        Timestamp of the alarm comment creation, in milliseconds  # noqa: E501
+
+        :param created_time: The created_time of this AlarmCommentInfo.  # noqa: E501
+        :type: int
+        """
+
+        self._created_time = created_time
+
+    @property
+    def alarm_id(self):
+        """Gets the alarm_id of this AlarmCommentInfo.  # noqa: E501
+
+
+        :return: The alarm_id of this AlarmCommentInfo.  # noqa: E501
+        :rtype: AlarmId
+        """
+        return self._alarm_id
+
+    @alarm_id.setter
+    def alarm_id(self, alarm_id):
+        """Sets the alarm_id of this AlarmCommentInfo.
+
+
+        :param alarm_id: The alarm_id of this AlarmCommentInfo.  # noqa: E501
+        :type: AlarmId
+        """
+
+        self._alarm_id = alarm_id
+
+    @property
+    def user_id(self):
+        """Gets the user_id of this AlarmCommentInfo.  # noqa: E501
+
+
+        :return: The user_id of this AlarmCommentInfo.  # noqa: E501
+        :rtype: UserId
+        """
+        return self._user_id
+
+    @user_id.setter
+    def user_id(self, user_id):
+        """Sets the user_id of this AlarmCommentInfo.
+
+
+        :param user_id: The user_id of this AlarmCommentInfo.  # noqa: E501
+        :type: UserId
+        """
+
+        self._user_id = user_id
+
+    @property
+    def type(self):
+        """Gets the type of this AlarmCommentInfo.  # noqa: E501
+
+        Defines origination of comment. System type means comment was created by TB. OTHER type means comment was created by user.  # noqa: E501
+
+        :return: The type of this AlarmCommentInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this AlarmCommentInfo.
+
+        Defines origination of comment. System type means comment was created by TB. OTHER type means comment was created by user.  # noqa: E501
+
+        :param type: The type of this AlarmCommentInfo.  # noqa: E501
+        :type: str
+        """
+        allowed_values = ["SYSTEM", "OTHER"]  # noqa: E501
+        if type not in allowed_values:
+            raise ValueError(
+                "Invalid value for `type` ({0}), must be one of {1}"  # noqa: E501
+                .format(type, allowed_values)
+            )
+
+        self._type = type
+
+    @property
+    def comment(self):
+        """Gets the comment of this AlarmCommentInfo.  # noqa: E501
+
+
+        :return: The comment of this AlarmCommentInfo.  # noqa: E501
+        :rtype: JsonNode
+        """
+        return self._comment
+
+    @comment.setter
+    def comment(self, comment):
+        """Sets the comment of this AlarmCommentInfo.
+
+
+        :param comment: The comment of this AlarmCommentInfo.  # noqa: E501
+        :type: JsonNode
+        """
+
+        self._comment = comment
+
+    @property
+    def first_name(self):
+        """Gets the first_name of this AlarmCommentInfo.  # noqa: E501
+
+        User first name  # noqa: E501
+
+        :return: The first_name of this AlarmCommentInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._first_name
+
+    @first_name.setter
+    def first_name(self, first_name):
+        """Sets the first_name of this AlarmCommentInfo.
+
+        User first name  # noqa: E501
+
+        :param first_name: The first_name of this AlarmCommentInfo.  # noqa: E501
+        :type: str
+        """
+
+        self._first_name = first_name
+
+    @property
+    def last_name(self):
+        """Gets the last_name of this AlarmCommentInfo.  # noqa: E501
+
+        User last name  # noqa: E501
+
+        :return: The last_name of this AlarmCommentInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._last_name
+
+    @last_name.setter
+    def last_name(self, last_name):
+        """Sets the last_name of this AlarmCommentInfo.
+
+        User last name  # noqa: E501
+
+        :param last_name: The last_name of this AlarmCommentInfo.  # noqa: E501
+        :type: str
+        """
+
+        self._last_name = last_name
+
+    @property
+    def email(self):
+        """Gets the email of this AlarmCommentInfo.  # noqa: E501
+
+        User email address  # noqa: E501
+
+        :return: The email of this AlarmCommentInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._email
+
+    @email.setter
+    def email(self, email):
+        """Sets the email of this AlarmCommentInfo.
+
+        User email address  # noqa: E501
+
+        :param email: The email of this AlarmCommentInfo.  # noqa: E501
+        :type: str
+        """
+
+        self._email = email
+
+    @property
+    def name(self):
+        """Gets the name of this AlarmCommentInfo.  # noqa: E501
+
+        representing comment text  # noqa: E501
+
+        :return: The name of this AlarmCommentInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """Sets the name of this AlarmCommentInfo.
+
+        representing comment text  # noqa: E501
+
+        :param name: The name of this AlarmCommentInfo.  # noqa: E501
+        :type: str
+        """
+
+        self._name = name
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+        if issubclass(AlarmCommentInfo, dict):
+            for key, value in self.items():
+                result[key] = 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, AlarmCommentInfo):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

tb_rest_client/models/models_pe/alarm_comment_notification_rule_trigger_config.py

@@ -0,0 +1,248 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
+
+    OpenAPI spec version: 3.7.0PE
+    Contact: info@thingsboard.io
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+#  Copyright 2024. ThingsBoard
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import pprint
+import re  # noqa: F401
+
+import six
+from tb_rest_client.models.models_ce.notification_rule_trigger_config import NotificationRuleTriggerConfig  # noqa: F401,E501
+
+class AlarmCommentNotificationRuleTriggerConfig(NotificationRuleTriggerConfig):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+    """
+    Attributes:
+      swagger_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.
+    """
+    swagger_types = {
+        'alarm_types': 'list[str]',
+        'alarm_severities': 'list[str]',
+        'alarm_statuses': 'list[str]',
+        'only_user_comments': 'bool',
+        'notify_on_comment_update': 'bool'
+    }
+    if hasattr(NotificationRuleTriggerConfig, "swagger_types"):
+        swagger_types.update(NotificationRuleTriggerConfig.swagger_types)
+
+    attribute_map = {
+        'alarm_types': 'alarmTypes',
+        'alarm_severities': 'alarmSeverities',
+        'alarm_statuses': 'alarmStatuses',
+        'only_user_comments': 'onlyUserComments',
+        'notify_on_comment_update': 'notifyOnCommentUpdate'
+    }
+    if hasattr(NotificationRuleTriggerConfig, "attribute_map"):
+        attribute_map.update(NotificationRuleTriggerConfig.attribute_map)
+
+    def __init__(self, alarm_types=None, alarm_severities=None, alarm_statuses=None, only_user_comments=None, notify_on_comment_update=None, *args, **kwargs):  # noqa: E501
+        """AlarmCommentNotificationRuleTriggerConfig - a model defined in Swagger"""  # noqa: E501
+        self._alarm_types = None
+        self._alarm_severities = None
+        self._alarm_statuses = None
+        self._only_user_comments = None
+        self._notify_on_comment_update = None
+        self.discriminator = None
+        if alarm_types is not None:
+            self.alarm_types = alarm_types
+        if alarm_severities is not None:
+            self.alarm_severities = alarm_severities
+        if alarm_statuses is not None:
+            self.alarm_statuses = alarm_statuses
+        if only_user_comments is not None:
+            self.only_user_comments = only_user_comments
+        if notify_on_comment_update is not None:
+            self.notify_on_comment_update = notify_on_comment_update
+        NotificationRuleTriggerConfig.__init__(self, *args, **kwargs)
+
+    @property
+    def alarm_types(self):
+        """Gets the alarm_types of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The alarm_types of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._alarm_types
+
+    @alarm_types.setter
+    def alarm_types(self, alarm_types):
+        """Sets the alarm_types of this AlarmCommentNotificationRuleTriggerConfig.
+
+
+        :param alarm_types: The alarm_types of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._alarm_types = alarm_types
+
+    @property
+    def alarm_severities(self):
+        """Gets the alarm_severities of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The alarm_severities of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._alarm_severities
+
+    @alarm_severities.setter
+    def alarm_severities(self, alarm_severities):
+        """Sets the alarm_severities of this AlarmCommentNotificationRuleTriggerConfig.
+
+
+        :param alarm_severities: The alarm_severities of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :type: list[str]
+        """
+        allowed_values = ["CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE"]  # noqa: E501
+        if not set(alarm_severities).issubset(set(allowed_values)):
+            raise ValueError(
+                "Invalid values for `alarm_severities` [{0}], must be a subset of [{1}]"  # noqa: E501
+                .format(", ".join(map(str, set(alarm_severities) - set(allowed_values))),  # noqa: E501
+                        ", ".join(map(str, allowed_values)))
+            )
+
+        self._alarm_severities = alarm_severities
+
+    @property
+    def alarm_statuses(self):
+        """Gets the alarm_statuses of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The alarm_statuses of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._alarm_statuses
+
+    @alarm_statuses.setter
+    def alarm_statuses(self, alarm_statuses):
+        """Sets the alarm_statuses of this AlarmCommentNotificationRuleTriggerConfig.
+
+
+        :param alarm_statuses: The alarm_statuses of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :type: list[str]
+        """
+        allowed_values = ["ANY", "ACTIVE", "CLEARED", "ACK", "UNACK"]  # noqa: E501
+        if not set(alarm_statuses).issubset(set(allowed_values)):
+            raise ValueError(
+                "Invalid values for `alarm_statuses` [{0}], must be a subset of [{1}]"  # noqa: E501
+                .format(", ".join(map(str, set(alarm_statuses) - set(allowed_values))),  # noqa: E501
+                        ", ".join(map(str, allowed_values)))
+            )
+
+        self._alarm_statuses = alarm_statuses
+
+    @property
+    def only_user_comments(self):
+        """Gets the only_user_comments of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The only_user_comments of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: bool
+        """
+        return self._only_user_comments
+
+    @only_user_comments.setter
+    def only_user_comments(self, only_user_comments):
+        """Sets the only_user_comments of this AlarmCommentNotificationRuleTriggerConfig.
+
+
+        :param only_user_comments: The only_user_comments of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :type: bool
+        """
+
+        self._only_user_comments = only_user_comments
+
+    @property
+    def notify_on_comment_update(self):
+        """Gets the notify_on_comment_update of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The notify_on_comment_update of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: bool
+        """
+        return self._notify_on_comment_update
+
+    @notify_on_comment_update.setter
+    def notify_on_comment_update(self, notify_on_comment_update):
+        """Sets the notify_on_comment_update of this AlarmCommentNotificationRuleTriggerConfig.
+
+
+        :param notify_on_comment_update: The notify_on_comment_update of this AlarmCommentNotificationRuleTriggerConfig.  # noqa: E501
+        :type: bool
+        """
+
+        self._notify_on_comment_update = notify_on_comment_update
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+        if issubclass(AlarmCommentNotificationRuleTriggerConfig, dict):
+            for key, value in self.items():
+                result[key] = 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, AlarmCommentNotificationRuleTriggerConfig):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other