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

tb_rest_client/api/api_ce/trendz_controller_api.py

@@ -0,0 +1,219 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
+
+    OpenAPI spec version: 4.1.0
+    Contact: info@thingsboard.io
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from tb_rest_client.api_client import ApiClient
+
+
+class TrendzControllerApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def get_trendz_settings(self, **kwargs):  # noqa: E501
+        """Get Trendz Settings (getTrendzSettings)  # noqa: E501
+
+        Retrieves Trendz settings for this tenant.  Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_trendz_settings(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: TrendzSettings
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_trendz_settings_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_trendz_settings_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_trendz_settings_with_http_info(self, **kwargs):  # noqa: E501
+        """Get Trendz Settings (getTrendzSettings)  # noqa: E501
+
+        Retrieves Trendz settings for this tenant.  Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_trendz_settings_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: TrendzSettings
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = []  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_trendz_settings" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['X-Authorization']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/api/trendz/settings', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='TrendzSettings',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def save_trendz_settings(self, body, **kwargs):  # noqa: E501
+        """Save Trendz settings (saveTrendzSettings)  # noqa: E501
+
+        Saves Trendz settings for this tenant.   Here is an example of the Trendz settings: ```json {   \"enabled\": true,   \"baseUrl\": \"https://some.domain.com:18888/also_necessary_prefix\" } ```  Available for users with 'TENANT_ADMIN' authority.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.save_trendz_settings(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param TrendzSettings body: (required)
+        :return: TrendzSettings
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.save_trendz_settings_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.save_trendz_settings_with_http_info(body, **kwargs)  # noqa: E501
+            return data
+
+    def save_trendz_settings_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Save Trendz settings (saveTrendzSettings)  # noqa: E501
+
+        Saves Trendz settings for this tenant.   Here is an example of the Trendz settings: ```json {   \"enabled\": true,   \"baseUrl\": \"https://some.domain.com:18888/also_necessary_prefix\" } ```  Available for users with 'TENANT_ADMIN' authority.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.save_trendz_settings_with_http_info(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param TrendzSettings body: (required)
+        :return: TrendzSettings
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['body']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method save_trendz_settings" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `save_trendz_settings`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            body_params = params['body']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['X-Authorization']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/api/trendz/settings', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='TrendzSettings',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)

tb_rest_client/api/api_ce/two_factor_auth_config_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0
+    OpenAPI spec version: 4.1.0
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -500,7 +500,7 @@ class TwoFactorAuthConfigControllerApi(object):
     def save_platform_two_fa_settings_using_post(self, **kwargs):  # noqa: E501
         """Save platform 2FA settings (savePlatformTwoFaSettings)  # noqa: E501
 
-        Save 2FA settings for platform. The settings have following properties: - `providers` - the list of 2FA providers' configs. Users will only be allowed to use 2FA providers from this list.   - `minVerificationCodeSendPeriod` - minimal period in seconds to wait after verification code send request to send next request.  - `verificationCodeCheckRateLimit` - rate limit configuration for verification code checking. The format is standard: 'amountOfRequests:periodInSeconds'. The value of '1:60' would limit verification code checking requests to one per minute. - `maxVerificationFailuresBeforeUserLockout` - maximum number of verification failures before a user gets disabled. - `totalAllowedTimeForVerification` - total amount of time in seconds allotted for verification. Basically, this property sets a lifetime for pre-verification token. If not set, default value of 30 minutes is used.   TOTP 2FA provider config has following settings: - `issuerName` - issuer name that will be displayed in an authenticator app near a username. Must not be blank.  For SMS 2FA provider: - `smsVerificationMessageTemplate` - verification message template.  Available template variables are ${code} and ${userEmail}. It must not be blank and must contain verification code variable. - `verificationCodeLifetime` - verification code lifetime in seconds. Required to be positive.  For EMAIL provider type: - `verificationCodeLifetime` - the same as for SMS.  Example of the settings: ``` {   \"providers\": [     {       \"providerType\": \"TOTP\",       \"issuerName\": \"TB\"     },     {       \"providerType\": \"EMAIL\",       \"verificationCodeLifetime\": 60     },     {       \"providerType\": \"SMS\",       \"verificationCodeLifetime\": 60,       \"smsVerificationMessageTemplate\": \"Here is your verification code: ${code}\"     }   ],   \"minVerificationCodeSendPeriod\": 60,   \"verificationCodeCheckRateLimit\": \"3:900\",   \"maxVerificationFailuresBeforeUserLockout\": 10,   \"totalAllowedTimeForVerification\": 600 } ```  Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.  # noqa: E501
+        Save 2FA settings for platform. The settings have following properties: - `providers` - the list of 2FA providers' configs. Users will only be allowed to use 2FA providers from this list.   - `minVerificationCodeSendPeriod` - minimal period in seconds to wait after verification code send request to send next request.  - `verificationCodeCheckRateLimit` - rate limit configuration for verification code checking. The format is standard: 'amountOfRequests:periodInSeconds'. The value of '1:60' would limit verification code checking requests to one per minute. - `maxVerificationFailuresBeforeUserLockout` - maximum number of verification failures before a user gets disabled. - `totalAllowedTimeForVerification` - total amount of time in seconds allotted for verification. Basically, this property sets a lifetime for pre-verification token. If not set, default value of 30 minutes is used.   TOTP 2FA provider config has following settings: - `issuerName` - issuer name that will be displayed in an authenticator app near a username. Must not be blank.  For SMS 2FA provider: - `smsVerificationMessageTemplate` - verification message template.  Available template variables are ${code} and ${userEmail}. It must not be blank and must contain verification code variable. - `verificationCodeLifetime` - verification code lifetime in seconds. Required to be positive.  For EMAIL provider type: - `verificationCodeLifetime` - the same as for SMS.  Example of the settings: ``` {   \"providers\": [     {       \"providerType\": \"TOTP\",       \"issuerName\": \"TB\"     },     {       \"providerType\": \"EMAIL\",       \"verificationCodeLifetime\": 60     },     {       \"providerType\": \"SMS\",       \"verificationCodeLifetime\": 60,       \"smsVerificationMessageTemplate\": \"Here is your verification code: ${code}\"     }   ],   \"minVerificationCodeSendPeriod\": 60,   \"verificationCodeCheckRateLimit\": \"4.1.0\",   \"maxVerificationFailuresBeforeUserLockout\": 10,   \"totalAllowedTimeForVerification\": 600 } ```  Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.save_platform_two_fa_settings_using_post(async_req=True)
@@ -522,7 +522,7 @@ class TwoFactorAuthConfigControllerApi(object):
     def save_platform_two_fa_settings_using_post_with_http_info(self, **kwargs):  # noqa: E501
         """Save platform 2FA settings (savePlatformTwoFaSettings)  # noqa: E501
 
-        Save 2FA settings for platform. The settings have following properties: - `providers` - the list of 2FA providers' configs. Users will only be allowed to use 2FA providers from this list.   - `minVerificationCodeSendPeriod` - minimal period in seconds to wait after verification code send request to send next request.  - `verificationCodeCheckRateLimit` - rate limit configuration for verification code checking. The format is standard: 'amountOfRequests:periodInSeconds'. The value of '1:60' would limit verification code checking requests to one per minute. - `maxVerificationFailuresBeforeUserLockout` - maximum number of verification failures before a user gets disabled. - `totalAllowedTimeForVerification` - total amount of time in seconds allotted for verification. Basically, this property sets a lifetime for pre-verification token. If not set, default value of 30 minutes is used.   TOTP 2FA provider config has following settings: - `issuerName` - issuer name that will be displayed in an authenticator app near a username. Must not be blank.  For SMS 2FA provider: - `smsVerificationMessageTemplate` - verification message template.  Available template variables are ${code} and ${userEmail}. It must not be blank and must contain verification code variable. - `verificationCodeLifetime` - verification code lifetime in seconds. Required to be positive.  For EMAIL provider type: - `verificationCodeLifetime` - the same as for SMS.  Example of the settings: ``` {   \"providers\": [     {       \"providerType\": \"TOTP\",       \"issuerName\": \"TB\"     },     {       \"providerType\": \"EMAIL\",       \"verificationCodeLifetime\": 60     },     {       \"providerType\": \"SMS\",       \"verificationCodeLifetime\": 60,       \"smsVerificationMessageTemplate\": \"Here is your verification code: ${code}\"     }   ],   \"minVerificationCodeSendPeriod\": 60,   \"verificationCodeCheckRateLimit\": \"3:900\",   \"maxVerificationFailuresBeforeUserLockout\": 10,   \"totalAllowedTimeForVerification\": 600 } ```  Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.  # noqa: E501
+        Save 2FA settings for platform. The settings have following properties: - `providers` - the list of 2FA providers' configs. Users will only be allowed to use 2FA providers from this list.   - `minVerificationCodeSendPeriod` - minimal period in seconds to wait after verification code send request to send next request.  - `verificationCodeCheckRateLimit` - rate limit configuration for verification code checking. The format is standard: 'amountOfRequests:periodInSeconds'. The value of '1:60' would limit verification code checking requests to one per minute. - `maxVerificationFailuresBeforeUserLockout` - maximum number of verification failures before a user gets disabled. - `totalAllowedTimeForVerification` - total amount of time in seconds allotted for verification. Basically, this property sets a lifetime for pre-verification token. If not set, default value of 30 minutes is used.   TOTP 2FA provider config has following settings: - `issuerName` - issuer name that will be displayed in an authenticator app near a username. Must not be blank.  For SMS 2FA provider: - `smsVerificationMessageTemplate` - verification message template.  Available template variables are ${code} and ${userEmail}. It must not be blank and must contain verification code variable. - `verificationCodeLifetime` - verification code lifetime in seconds. Required to be positive.  For EMAIL provider type: - `verificationCodeLifetime` - the same as for SMS.  Example of the settings: ``` {   \"providers\": [     {       \"providerType\": \"TOTP\",       \"issuerName\": \"TB\"     },     {       \"providerType\": \"EMAIL\",       \"verificationCodeLifetime\": 60     },     {       \"providerType\": \"SMS\",       \"verificationCodeLifetime\": 60,       \"smsVerificationMessageTemplate\": \"Here is your verification code: ${code}\"     }   ],   \"minVerificationCodeSendPeriod\": 60,   \"verificationCodeCheckRateLimit\": \"4.1.0\",   \"maxVerificationFailuresBeforeUserLockout\": 10,   \"totalAllowedTimeForVerification\": 600 } ```  Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.save_platform_two_fa_settings_using_post_with_http_info(async_req=True)

tb_rest_client/api/api_ce/two_factor_auth_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0
+    OpenAPI spec version: 4.1.0
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_ce/ui_settings_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0
+    OpenAPI spec version: 4.1.0
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_ce/usage_info_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0
+    OpenAPI spec version: 4.1.0
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_ce/user_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0
+    OpenAPI spec version: 4.1.0
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_ce/widget_type_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0
+    OpenAPI spec version: 4.1.0
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_ce/widgets_bundle_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard open-source IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0
+    OpenAPI spec version: 4.1.0
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/__init__.py

@@ -65,3 +65,8 @@ from .mobile_app_bundle_controller_api import MobileAppBundleControllerApi
 from .qr_code_settings_controller_api import QrCodeSettingsControllerApi
 from .billing_endpoint_controller_api import BillingEndpointControllerApi
 from .cloud_endpoint_controller_api import CloudEndpointControllerApi
+from .calculated_field_controller_api import CalculatedFieldControllerApi
+from .job_controller_api import JobControllerApi
+from .secret_controller_api import SecretControllerApi
+from .trendz_controller_api import TrendzControllerApi
+from .rule_chain_controller_api import RuleChainControllerApi

tb_rest_client/api/api_pe/admin_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/alarm_comment_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/alarm_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/asset_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/asset_profile_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/audit_log_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/auth_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/billing_endpoint_controller_api.py

@@ -5,7 +5,7 @@
 
     For instructions how to authorize requests please visit <a href='http://thingsboard.io/docs/reference/rest-api/'>REST API documentation page</a>.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

tb_rest_client/api/api_pe/blob_entity_controller_api.py

@@ -5,7 +5,7 @@
 
      ThingsBoard Professional Edition IoT platform REST API documentation.  # noqa: E501
 
-    OpenAPI spec version: 3.9.0PE
+    OpenAPI spec version: 4.1.0PE
     Contact: info@thingsboard.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """