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

tb_rest_client/models/models_pe/o_auth2_basic_mapper_config.py

@@ -0,0 +1,381 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
+
+    OpenAPI spec version: 3.9.0PE
+    Contact: info@thingsboard.io
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+#  Copyright 2025. 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 OAuth2BasicMapperConfig(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 = {
+        'email_attribute_key': 'str',
+        'first_name_attribute_key': 'str',
+        'last_name_attribute_key': 'str',
+        'tenant_name_strategy': 'str',
+        'tenant_name_pattern': 'str',
+        'customer_name_pattern': 'str',
+        'default_dashboard_name': 'str',
+        'always_full_screen': 'bool',
+        'parent_customer_name_pattern': 'str',
+        'user_groups_name_pattern': 'list[str]'
+    }
+
+    attribute_map = {
+        'email_attribute_key': 'emailAttributeKey',
+        'first_name_attribute_key': 'firstNameAttributeKey',
+        'last_name_attribute_key': 'lastNameAttributeKey',
+        'tenant_name_strategy': 'tenantNameStrategy',
+        'tenant_name_pattern': 'tenantNamePattern',
+        'customer_name_pattern': 'customerNamePattern',
+        'default_dashboard_name': 'defaultDashboardName',
+        'always_full_screen': 'alwaysFullScreen',
+        'parent_customer_name_pattern': 'parentCustomerNamePattern',
+        'user_groups_name_pattern': 'userGroupsNamePattern'
+    }
+
+    def __init__(self, email_attribute_key=None, first_name_attribute_key=None, last_name_attribute_key=None, tenant_name_strategy=None, tenant_name_pattern=None, customer_name_pattern=None, default_dashboard_name=None, always_full_screen=None, parent_customer_name_pattern=None, user_groups_name_pattern=None):  # noqa: E501
+        """OAuth2BasicMapperConfig - a model defined in Swagger"""  # noqa: E501
+        self._email_attribute_key = None
+        self._first_name_attribute_key = None
+        self._last_name_attribute_key = None
+        self._tenant_name_strategy = None
+        self._tenant_name_pattern = None
+        self._customer_name_pattern = None
+        self._default_dashboard_name = None
+        self._always_full_screen = None
+        self._parent_customer_name_pattern = None
+        self._user_groups_name_pattern = None
+        self.discriminator = None
+        if email_attribute_key is not None:
+            self.email_attribute_key = email_attribute_key
+        if first_name_attribute_key is not None:
+            self.first_name_attribute_key = first_name_attribute_key
+        if last_name_attribute_key is not None:
+            self.last_name_attribute_key = last_name_attribute_key
+        self.tenant_name_strategy = tenant_name_strategy
+        if tenant_name_pattern is not None:
+            self.tenant_name_pattern = tenant_name_pattern
+        if customer_name_pattern is not None:
+            self.customer_name_pattern = customer_name_pattern
+        if default_dashboard_name is not None:
+            self.default_dashboard_name = default_dashboard_name
+        if always_full_screen is not None:
+            self.always_full_screen = always_full_screen
+        if parent_customer_name_pattern is not None:
+            self.parent_customer_name_pattern = parent_customer_name_pattern
+        if user_groups_name_pattern is not None:
+            self.user_groups_name_pattern = user_groups_name_pattern
+
+    @property
+    def email_attribute_key(self):
+        """Gets the email_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        Email attribute key of OAuth2 principal attributes. Must be specified for BASIC mapper type and cannot be specified for GITHUB type  # noqa: E501
+
+        :return: The email_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._email_attribute_key
+
+    @email_attribute_key.setter
+    def email_attribute_key(self, email_attribute_key):
+        """Sets the email_attribute_key of this OAuth2BasicMapperConfig.
+
+        Email attribute key of OAuth2 principal attributes. Must be specified for BASIC mapper type and cannot be specified for GITHUB type  # noqa: E501
+
+        :param email_attribute_key: The email_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+
+        self._email_attribute_key = email_attribute_key
+
+    @property
+    def first_name_attribute_key(self):
+        """Gets the first_name_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        First name attribute key  # noqa: E501
+
+        :return: The first_name_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._first_name_attribute_key
+
+    @first_name_attribute_key.setter
+    def first_name_attribute_key(self, first_name_attribute_key):
+        """Sets the first_name_attribute_key of this OAuth2BasicMapperConfig.
+
+        First name attribute key  # noqa: E501
+
+        :param first_name_attribute_key: The first_name_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+
+        self._first_name_attribute_key = first_name_attribute_key
+
+    @property
+    def last_name_attribute_key(self):
+        """Gets the last_name_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        Last name attribute key  # noqa: E501
+
+        :return: The last_name_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._last_name_attribute_key
+
+    @last_name_attribute_key.setter
+    def last_name_attribute_key(self, last_name_attribute_key):
+        """Sets the last_name_attribute_key of this OAuth2BasicMapperConfig.
+
+        Last name attribute key  # noqa: E501
+
+        :param last_name_attribute_key: The last_name_attribute_key of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+
+        self._last_name_attribute_key = last_name_attribute_key
+
+    @property
+    def tenant_name_strategy(self):
+        """Gets the tenant_name_strategy of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        Tenant naming strategy. For DOMAIN type, domain for tenant name will be taken from the email (substring before '@')  # noqa: E501
+
+        :return: The tenant_name_strategy of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._tenant_name_strategy
+
+    @tenant_name_strategy.setter
+    def tenant_name_strategy(self, tenant_name_strategy):
+        """Sets the tenant_name_strategy of this OAuth2BasicMapperConfig.
+
+        Tenant naming strategy. For DOMAIN type, domain for tenant name will be taken from the email (substring before '@')  # noqa: E501
+
+        :param tenant_name_strategy: The tenant_name_strategy of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+        if tenant_name_strategy is None:
+            raise ValueError("Invalid value for `tenant_name_strategy`, must not be `None`")  # noqa: E501
+        allowed_values = ["DOMAIN", "EMAIL", "CUSTOM"]  # noqa: E501
+        if tenant_name_strategy not in allowed_values:
+            raise ValueError(
+                "Invalid value for `tenant_name_strategy` ({0}), must be one of {1}"  # noqa: E501
+                .format(tenant_name_strategy, allowed_values)
+            )
+
+        self._tenant_name_strategy = tenant_name_strategy
+
+    @property
+    def tenant_name_pattern(self):
+        """Gets the tenant_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        Tenant name pattern for CUSTOM naming strategy. OAuth2 attributes in the pattern can be used by enclosing attribute key in '%{' and '}'  # noqa: E501
+
+        :return: The tenant_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._tenant_name_pattern
+
+    @tenant_name_pattern.setter
+    def tenant_name_pattern(self, tenant_name_pattern):
+        """Sets the tenant_name_pattern of this OAuth2BasicMapperConfig.
+
+        Tenant name pattern for CUSTOM naming strategy. OAuth2 attributes in the pattern can be used by enclosing attribute key in '%{' and '}'  # noqa: E501
+
+        :param tenant_name_pattern: The tenant_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+
+        self._tenant_name_pattern = tenant_name_pattern
+
+    @property
+    def customer_name_pattern(self):
+        """Gets the customer_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        Customer name pattern. When creating a user on the first OAuth2 log in, if specified, customer name will be used to create or find existing customer in the platform and assign customerId to the user  # noqa: E501
+
+        :return: The customer_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._customer_name_pattern
+
+    @customer_name_pattern.setter
+    def customer_name_pattern(self, customer_name_pattern):
+        """Sets the customer_name_pattern of this OAuth2BasicMapperConfig.
+
+        Customer name pattern. When creating a user on the first OAuth2 log in, if specified, customer name will be used to create or find existing customer in the platform and assign customerId to the user  # noqa: E501
+
+        :param customer_name_pattern: The customer_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+
+        self._customer_name_pattern = customer_name_pattern
+
+    @property
+    def default_dashboard_name(self):
+        """Gets the default_dashboard_name of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        Name of the tenant's dashboard to set as default dashboard for newly created user  # noqa: E501
+
+        :return: The default_dashboard_name of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._default_dashboard_name
+
+    @default_dashboard_name.setter
+    def default_dashboard_name(self, default_dashboard_name):
+        """Sets the default_dashboard_name of this OAuth2BasicMapperConfig.
+
+        Name of the tenant's dashboard to set as default dashboard for newly created user  # noqa: E501
+
+        :param default_dashboard_name: The default_dashboard_name of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+
+        self._default_dashboard_name = default_dashboard_name
+
+    @property
+    def always_full_screen(self):
+        """Gets the always_full_screen of this OAuth2BasicMapperConfig.  # noqa: E501
+
+        Whether default dashboard should be open in full screen  # noqa: E501
+
+        :return: The always_full_screen of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: bool
+        """
+        return self._always_full_screen
+
+    @always_full_screen.setter
+    def always_full_screen(self, always_full_screen):
+        """Sets the always_full_screen of this OAuth2BasicMapperConfig.
+
+        Whether default dashboard should be open in full screen  # noqa: E501
+
+        :param always_full_screen: The always_full_screen of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: bool
+        """
+
+        self._always_full_screen = always_full_screen
+
+    @property
+    def parent_customer_name_pattern(self):
+        """Gets the parent_customer_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+
+
+        :return: The parent_customer_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: str
+        """
+        return self._parent_customer_name_pattern
+
+    @parent_customer_name_pattern.setter
+    def parent_customer_name_pattern(self, parent_customer_name_pattern):
+        """Sets the parent_customer_name_pattern of this OAuth2BasicMapperConfig.
+
+
+        :param parent_customer_name_pattern: The parent_customer_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: str
+        """
+
+        self._parent_customer_name_pattern = parent_customer_name_pattern
+
+    @property
+    def user_groups_name_pattern(self):
+        """Gets the user_groups_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+
+
+        :return: The user_groups_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._user_groups_name_pattern
+
+    @user_groups_name_pattern.setter
+    def user_groups_name_pattern(self, user_groups_name_pattern):
+        """Sets the user_groups_name_pattern of this OAuth2BasicMapperConfig.
+
+
+        :param user_groups_name_pattern: The user_groups_name_pattern of this OAuth2BasicMapperConfig.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._user_groups_name_pattern = user_groups_name_pattern
+
+    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(OAuth2BasicMapperConfig, 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, OAuth2BasicMapperConfig):
+            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/o_auth2_client_info.py

@@ -0,0 +1,267 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
+
+    OpenAPI spec version: 3.9.0PE
+    Contact: info@thingsboard.io
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+#  Copyright 2025. 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 OAuth2ClientInfo(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': 'OAuth2ClientId',
+        'created_time': 'int',
+        'title': 'str',
+        'provider_name': 'str',
+        'platforms': 'list[str]',
+        'name': 'str'
+    }
+
+    attribute_map = {
+        'id': 'id',
+        'created_time': 'createdTime',
+        'title': 'title',
+        'provider_name': 'providerName',
+        'platforms': 'platforms',
+        'name': 'name'
+    }
+
+    def __init__(self, id=None, created_time=None, title=None, provider_name=None, platforms=None, name=None):  # noqa: E501
+        """OAuth2ClientInfo - a model defined in Swagger"""  # noqa: E501
+        self._id = None
+        self._created_time = None
+        self._title = None
+        self._provider_name = None
+        self._platforms = 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 title is not None:
+            self.title = title
+        if provider_name is not None:
+            self.provider_name = provider_name
+        if platforms is not None:
+            self.platforms = platforms
+        if name is not None:
+            self.name = name
+
+    @property
+    def id(self):
+        """Gets the id of this OAuth2ClientInfo.  # noqa: E501
+
+
+        :return: The id of this OAuth2ClientInfo.  # noqa: E501
+        :rtype: OAuth2ClientId
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this OAuth2ClientInfo.
+
+
+        :param id: The id of this OAuth2ClientInfo.  # noqa: E501
+        :type: OAuth2ClientId
+        """
+
+        self._id = id
+
+    @property
+    def created_time(self):
+        """Gets the created_time of this OAuth2ClientInfo.  # noqa: E501
+
+
+        :return: The created_time of this OAuth2ClientInfo.  # noqa: E501
+        :rtype: int
+        """
+        return self._created_time
+
+    @created_time.setter
+    def created_time(self, created_time):
+        """Sets the created_time of this OAuth2ClientInfo.
+
+
+        :param created_time: The created_time of this OAuth2ClientInfo.  # noqa: E501
+        :type: int
+        """
+
+        self._created_time = created_time
+
+    @property
+    def title(self):
+        """Gets the title of this OAuth2ClientInfo.  # noqa: E501
+
+        Oauth2 client registration title (e.g. My google)  # noqa: E501
+
+        :return: The title of this OAuth2ClientInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._title
+
+    @title.setter
+    def title(self, title):
+        """Sets the title of this OAuth2ClientInfo.
+
+        Oauth2 client registration title (e.g. My google)  # noqa: E501
+
+        :param title: The title of this OAuth2ClientInfo.  # noqa: E501
+        :type: str
+        """
+
+        self._title = title
+
+    @property
+    def provider_name(self):
+        """Gets the provider_name of this OAuth2ClientInfo.  # noqa: E501
+
+        Oauth2 client provider name (e.g. Google)  # noqa: E501
+
+        :return: The provider_name of this OAuth2ClientInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._provider_name
+
+    @provider_name.setter
+    def provider_name(self, provider_name):
+        """Sets the provider_name of this OAuth2ClientInfo.
+
+        Oauth2 client provider name (e.g. Google)  # noqa: E501
+
+        :param provider_name: The provider_name of this OAuth2ClientInfo.  # noqa: E501
+        :type: str
+        """
+
+        self._provider_name = provider_name
+
+    @property
+    def platforms(self):
+        """Gets the platforms of this OAuth2ClientInfo.  # noqa: E501
+
+        List of platforms for which usage of the OAuth2 client is allowed (empty for all allowed)  # noqa: E501
+
+        :return: The platforms of this OAuth2ClientInfo.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._platforms
+
+    @platforms.setter
+    def platforms(self, platforms):
+        """Sets the platforms of this OAuth2ClientInfo.
+
+        List of platforms for which usage of the OAuth2 client is allowed (empty for all allowed)  # noqa: E501
+
+        :param platforms: The platforms of this OAuth2ClientInfo.  # noqa: E501
+        :type: list[str]
+        """
+        allowed_values = ["WEB", "ANDROID", "IOS"]  # noqa: E501
+        if not set(platforms).issubset(set(allowed_values)):
+            raise ValueError(
+                "Invalid values for `platforms` [{0}], must be a subset of [{1}]"  # noqa: E501
+                .format(", ".join(map(str, set(platforms) - set(allowed_values))),  # noqa: E501
+                        ", ".join(map(str, allowed_values)))
+            )
+
+        self._platforms = platforms
+
+    @property
+    def name(self):
+        """Gets the name of this OAuth2ClientInfo.  # noqa: E501
+
+
+        :return: The name of this OAuth2ClientInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """Sets the name of this OAuth2ClientInfo.
+
+
+        :param name: The name of this OAuth2ClientInfo.  # 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(OAuth2ClientInfo, 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, OAuth2ClientInfo):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other