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

tb_rest_client/models/models_pe/alarm_notification_rule_trigger_config.py

@@ -0,0 +1,223 @@
+# 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 AlarmNotificationRuleTriggerConfig(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]',
+        'notify_on': 'list[str]',
+        'clear_rule': 'ClearRule'
+    }
+    if hasattr(NotificationRuleTriggerConfig, "swagger_types"):
+        swagger_types.update(NotificationRuleTriggerConfig.swagger_types)
+
+    attribute_map = {
+        'alarm_types': 'alarmTypes',
+        'alarm_severities': 'alarmSeverities',
+        'notify_on': 'notifyOn',
+        'clear_rule': 'clearRule'
+    }
+    if hasattr(NotificationRuleTriggerConfig, "attribute_map"):
+        attribute_map.update(NotificationRuleTriggerConfig.attribute_map)
+
+    def __init__(self, alarm_types=None, alarm_severities=None, notify_on=None, clear_rule=None, *args, **kwargs):  # noqa: E501
+        """AlarmNotificationRuleTriggerConfig - a model defined in Swagger"""  # noqa: E501
+        self._alarm_types = None
+        self._alarm_severities = None
+        self._notify_on = None
+        self._clear_rule = 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
+        self.notify_on = notify_on
+        if clear_rule is not None:
+            self.clear_rule = clear_rule
+        NotificationRuleTriggerConfig.__init__(self, *args, **kwargs)
+
+    @property
+    def alarm_types(self):
+        """Gets the alarm_types of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The alarm_types of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._alarm_types
+
+    @alarm_types.setter
+    def alarm_types(self, alarm_types):
+        """Sets the alarm_types of this AlarmNotificationRuleTriggerConfig.
+
+
+        :param alarm_types: The alarm_types of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._alarm_types = alarm_types
+
+    @property
+    def alarm_severities(self):
+        """Gets the alarm_severities of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The alarm_severities of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._alarm_severities
+
+    @alarm_severities.setter
+    def alarm_severities(self, alarm_severities):
+        """Sets the alarm_severities of this AlarmNotificationRuleTriggerConfig.
+
+
+        :param alarm_severities: The alarm_severities of this AlarmNotificationRuleTriggerConfig.  # 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 notify_on(self):
+        """Gets the notify_on of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The notify_on of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._notify_on
+
+    @notify_on.setter
+    def notify_on(self, notify_on):
+        """Sets the notify_on of this AlarmNotificationRuleTriggerConfig.
+
+
+        :param notify_on: The notify_on of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+        :type: list[str]
+        """
+        if notify_on is None:
+            raise ValueError("Invalid value for `notify_on`, must not be `None`")  # noqa: E501
+        allowed_values = ["CREATED", "SEVERITY_CHANGED", "ACKNOWLEDGED", "CLEARED"]  # noqa: E501
+        if not set(notify_on).issubset(set(allowed_values)):
+            raise ValueError(
+                "Invalid values for `notify_on` [{0}], must be a subset of [{1}]"  # noqa: E501
+                .format(", ".join(map(str, set(notify_on) - set(allowed_values))),  # noqa: E501
+                        ", ".join(map(str, allowed_values)))
+            )
+
+        self._notify_on = notify_on
+
+    @property
+    def clear_rule(self):
+        """Gets the clear_rule of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+
+
+        :return: The clear_rule of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+        :rtype: ClearRule
+        """
+        return self._clear_rule
+
+    @clear_rule.setter
+    def clear_rule(self, clear_rule):
+        """Sets the clear_rule of this AlarmNotificationRuleTriggerConfig.
+
+
+        :param clear_rule: The clear_rule of this AlarmNotificationRuleTriggerConfig.  # noqa: E501
+        :type: ClearRule
+        """
+
+        self._clear_rule = clear_rule
+
+    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(AlarmNotificationRuleTriggerConfig, 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, AlarmNotificationRuleTriggerConfig):
+            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_rule.py

@@ -0,0 +1,206 @@
+# 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 AlarmRule(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 = {
+        'condition': 'AlarmCondition',
+        'schedule': 'OneOfAlarmRuleSchedule',
+        'alarm_details': 'str',
+        'dashboard_id': 'DashboardId'
+    }
+
+    attribute_map = {
+        'condition': 'condition',
+        'schedule': 'schedule',
+        'alarm_details': 'alarmDetails',
+        'dashboard_id': 'dashboardId'
+    }
+
+    def __init__(self, condition=None, schedule=None, alarm_details=None, dashboard_id=None):  # noqa: E501
+        """AlarmRule - a model defined in Swagger"""  # noqa: E501
+        self._condition = None
+        self._schedule = None
+        self._alarm_details = None
+        self._dashboard_id = None
+        self.discriminator = None
+        if condition is not None:
+            self.condition = condition
+        if schedule is not None:
+            self.schedule = schedule
+        if alarm_details is not None:
+            self.alarm_details = alarm_details
+        if dashboard_id is not None:
+            self.dashboard_id = dashboard_id
+
+    @property
+    def condition(self):
+        """Gets the condition of this AlarmRule.  # noqa: E501
+
+
+        :return: The condition of this AlarmRule.  # noqa: E501
+        :rtype: AlarmCondition
+        """
+        return self._condition
+
+    @condition.setter
+    def condition(self, condition):
+        """Sets the condition of this AlarmRule.
+
+
+        :param condition: The condition of this AlarmRule.  # noqa: E501
+        :type: AlarmCondition
+        """
+
+        self._condition = condition
+
+    @property
+    def schedule(self):
+        """Gets the schedule of this AlarmRule.  # noqa: E501
+
+        JSON object representing time interval during which the rule is active  # noqa: E501
+
+        :return: The schedule of this AlarmRule.  # noqa: E501
+        :rtype: OneOfAlarmRuleSchedule
+        """
+        return self._schedule
+
+    @schedule.setter
+    def schedule(self, schedule):
+        """Sets the schedule of this AlarmRule.
+
+        JSON object representing time interval during which the rule is active  # noqa: E501
+
+        :param schedule: The schedule of this AlarmRule.  # noqa: E501
+        :type: OneOfAlarmRuleSchedule
+        """
+
+        self._schedule = schedule
+
+    @property
+    def alarm_details(self):
+        """Gets the alarm_details of this AlarmRule.  # noqa: E501
+
+        String value representing the additional details for an alarm rule  # noqa: E501
+
+        :return: The alarm_details of this AlarmRule.  # noqa: E501
+        :rtype: str
+        """
+        return self._alarm_details
+
+    @alarm_details.setter
+    def alarm_details(self, alarm_details):
+        """Sets the alarm_details of this AlarmRule.
+
+        String value representing the additional details for an alarm rule  # noqa: E501
+
+        :param alarm_details: The alarm_details of this AlarmRule.  # noqa: E501
+        :type: str
+        """
+
+        self._alarm_details = alarm_details
+
+    @property
+    def dashboard_id(self):
+        """Gets the dashboard_id of this AlarmRule.  # noqa: E501
+
+
+        :return: The dashboard_id of this AlarmRule.  # noqa: E501
+        :rtype: DashboardId
+        """
+        return self._dashboard_id
+
+    @dashboard_id.setter
+    def dashboard_id(self, dashboard_id):
+        """Sets the dashboard_id of this AlarmRule.
+
+
+        :param dashboard_id: The dashboard_id of this AlarmRule.  # noqa: E501
+        :type: DashboardId
+        """
+
+        self._dashboard_id = dashboard_id
+
+    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(AlarmRule, 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, AlarmRule):
+            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_schedule.py

@@ -0,0 +1,152 @@
+# 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
+"""
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+class AlarmSchedule(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 = {
+        'type': 'str',
+        'dynamic_value': 'DynamicValueString'
+    }
+
+    attribute_map = {
+        'type': 'type',
+        'dynamic_value': 'dynamicValue'
+    }
+
+    discriminator_value_class_map = {
+        'SpecificTimeSchedule': 'SpecificTimeSchedule',
+        'AnyTimeSchedule': 'AnyTimeSchedule',
+        'CustomTimeSchedule': 'CustomTimeSchedule'}
+
+    def __init__(self, type=None, dynamic_value=None):  # noqa: E501
+        """AlarmSchedule - a model defined in Swagger"""  # noqa: E501
+        self._type = None
+        self._dynamic_value = None
+        self.discriminator = 'type'
+        if type is not None:
+            self.type = type
+        if dynamic_value is not None:
+            self.dynamic_value = dynamic_value
+
+    @property
+    def type(self):
+        """Gets the type of this AlarmSchedule.  # noqa: E501
+
+
+        :return: The type of this AlarmSchedule.  # noqa: E501
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this AlarmSchedule.
+
+
+        :param type: The type of this AlarmSchedule.  # noqa: E501
+        :type: str
+        """
+        allowed_values = ["ANY_TIME", "SPECIFIC_TIME", "CUSTOM"]  # 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 dynamic_value(self):
+        """Gets the dynamic_value of this AlarmSchedule.  # noqa: E501
+
+
+        :return: The dynamic_value of this AlarmSchedule.  # noqa: E501
+        :rtype: DynamicValueString
+        """
+        return self._dynamic_value
+
+    @dynamic_value.setter
+    def dynamic_value(self, dynamic_value):
+        """Sets the dynamic_value of this AlarmSchedule.
+
+
+        :param dynamic_value: The dynamic_value of this AlarmSchedule.  # noqa: E501
+        :type: DynamicValueString
+        """
+
+        self._dynamic_value = dynamic_value
+
+    def get_real_child_model(self, data):
+        """Returns the real base class specified by the discriminator"""
+        discriminator_value = data[self.discriminator].lower()
+        return self.discriminator_value_class_map.get(discriminator_value)
+
+    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(AlarmSchedule, 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, AlarmSchedule):
+            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/all_users_filter.py

@@ -0,0 +1,104 @@
+# 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_pe.users_filter import UsersFilter  # noqa: F401,E501
+
+class AllUsersFilter(UsersFilter):
+    """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 = {
+    }
+    if hasattr(UsersFilter, "swagger_types"):
+        swagger_types.update(UsersFilter.swagger_types)
+
+    attribute_map = {
+    }
+    if hasattr(UsersFilter, "attribute_map"):
+        attribute_map.update(UsersFilter.attribute_map)
+
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """AllUsersFilter - a model defined in Swagger"""  # noqa: E501
+        self.discriminator = None
+        UsersFilter.__init__(self, *args, **kwargs)
+
+    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(AllUsersFilter, 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, AllUsersFilter):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other