extremecloudiq-api 24.3.1.2__py3-none-any.whl → 24.5.0.51__py3-none-any.whl

extremecloudiq/api/alert_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """
@@ -2584,6 +2584,8 @@ class AlertApi(object):
         :param list[int] message_metadata_ids: The message metadata ID list to filter
         :param bool acknowledged: The acknowledged to filter, return global data if not specified
         :param int site_id: The site id to filter
+        :param int floor_id: The floor id to filter
+        :param int building_id: The building id to filter
         :param str keyword: The keyword to filter, such as summary, severity, source, etc.
         :param XiqAlertSortField sort_field: The sort field
         :param XiqSortOrder order: The sort order (descending by default)
@@ -2620,6 +2622,8 @@ class AlertApi(object):
         :param list[int] message_metadata_ids: The message metadata ID list to filter
         :param bool acknowledged: The acknowledged to filter, return global data if not specified
         :param int site_id: The site id to filter
+        :param int floor_id: The floor id to filter
+        :param int building_id: The building id to filter
         :param str keyword: The keyword to filter, such as summary, severity, source, etc.
         :param XiqAlertSortField sort_field: The sort field
         :param XiqSortOrder order: The sort order (descending by default)
@@ -2649,6 +2653,8 @@ class AlertApi(object):
             'message_metadata_ids',
             'acknowledged',
             'site_id',
+            'floor_id',
+            'building_id',
             'keyword',
             'sort_field',
             'order'
@@ -2711,6 +2717,10 @@ class AlertApi(object):
             query_params.append(('acknowledged', local_var_params['acknowledged']))  # noqa: E501
         if 'site_id' in local_var_params and local_var_params['site_id'] is not None:  # noqa: E501
             query_params.append(('siteId', local_var_params['site_id']))  # noqa: E501
+        if 'floor_id' in local_var_params and local_var_params['floor_id'] is not None:  # noqa: E501
+            query_params.append(('floorId', local_var_params['floor_id']))  # noqa: E501
+        if 'building_id' in local_var_params and local_var_params['building_id'] is not None:  # noqa: E501
+            query_params.append(('buildingId', local_var_params['building_id']))  # noqa: E501
         if 'keyword' in local_var_params and local_var_params['keyword'] is not None:  # noqa: E501
             query_params.append(('keyword', local_var_params['keyword']))  # noqa: E501
         if 'sort_field' in local_var_params and local_var_params['sort_field'] is not None:  # noqa: E501

extremecloudiq/api/application_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/authentication_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/authorization_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/client_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/configuration___authentication_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/configuration___basic_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/configuration___certificate_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/configuration___deployment_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """
@@ -38,9 +38,9 @@ class ConfigurationDeploymentApi(object):
         self.api_client = api_client
 
     def deploy_config(self, xiq_deployment_request, **kwargs):  # noqa: E501
-        """Push configuration and upgrade firmware  # noqa: E501
+        """[LRO] Push configuration and upgrade firmware  # noqa: E501
 
-        Push configuration and upgrade firmware to the target devices.  # noqa: E501
+        Push configuration and upgrade firmware to the target devices. To avoid API timeout with large number of devices,   please make sure to enable async mode (set async=true in query parameter) and use long-running operation API to query the result.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.deploy_config(xiq_deployment_request, async_req=True)
@@ -48,6 +48,7 @@ class ConfigurationDeploymentApi(object):
 
         :param async_req bool: execute request asynchronously
         :param XiqDeploymentRequest xiq_deployment_request: The device deploy configuration (required)
+        :param bool _async: Whether to enable async mode
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -63,9 +64,9 @@ class ConfigurationDeploymentApi(object):
         return self.deploy_config_with_http_info(xiq_deployment_request, **kwargs)  # noqa: E501
 
     def deploy_config_with_http_info(self, xiq_deployment_request, **kwargs):  # noqa: E501
-        """Push configuration and upgrade firmware  # noqa: E501
+        """[LRO] Push configuration and upgrade firmware  # noqa: E501
 
-        Push configuration and upgrade firmware to the target devices.  # noqa: E501
+        Push configuration and upgrade firmware to the target devices. To avoid API timeout with large number of devices,   please make sure to enable async mode (set async=true in query parameter) and use long-running operation API to query the result.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.deploy_config_with_http_info(xiq_deployment_request, async_req=True)
@@ -73,6 +74,7 @@ class ConfigurationDeploymentApi(object):
 
         :param async_req bool: execute request asynchronously
         :param XiqDeploymentRequest xiq_deployment_request: The device deploy configuration (required)
+        :param bool _async: Whether to enable async mode
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -90,7 +92,8 @@ class ConfigurationDeploymentApi(object):
         local_var_params = locals()
 
         all_params = [
-            'xiq_deployment_request'
+            'xiq_deployment_request',
+            '_async'
         ]
         all_params.extend(
             [
@@ -119,6 +122,8 @@ class ConfigurationDeploymentApi(object):
         path_params = {}
 
         query_params = []
+        if '_async' in local_var_params and local_var_params['_async'] is not None:  # noqa: E501
+            query_params.append(('async', local_var_params['_async']))  # noqa: E501
 
         header_params = {}
 
@@ -374,3 +379,121 @@ class ConfigurationDeploymentApi(object):
             _preload_content=local_var_params.get('_preload_content', True),
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
+
+    def get_device_firmware_metadatas(self, xiq_firmware_metadatas_request, **kwargs):  # noqa: E501
+        """Get device firmware metadatas  # noqa: E501
+
+        Get the compatible firmware metadatas for the devices.  # 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_device_firmware_metadatas(xiq_firmware_metadatas_request, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param XiqFirmwareMetadatasRequest xiq_firmware_metadatas_request: (required)
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: XiqFirmwareMetadatasResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.get_device_firmware_metadatas_with_http_info(xiq_firmware_metadatas_request, **kwargs)  # noqa: E501
+
+    def get_device_firmware_metadatas_with_http_info(self, xiq_firmware_metadatas_request, **kwargs):  # noqa: E501
+        """Get device firmware metadatas  # noqa: E501
+
+        Get the compatible firmware metadatas for the devices.  # 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_device_firmware_metadatas_with_http_info(xiq_firmware_metadatas_request, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param XiqFirmwareMetadatasRequest xiq_firmware_metadatas_request: (required)
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: tuple(XiqFirmwareMetadatasResponse, status_code(int), headers(HTTPHeaderDict))
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'xiq_firmware_metadatas_request'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_device_firmware_metadatas" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'xiq_firmware_metadatas_request' is set
+        if self.api_client.client_side_validation and ('xiq_firmware_metadatas_request' not in local_var_params or  # noqa: E501
+                                                        local_var_params['xiq_firmware_metadatas_request'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `xiq_firmware_metadatas_request` when calling `get_device_firmware_metadatas`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'xiq_firmware_metadatas_request' in local_var_params:
+            body_params = local_var_params['xiq_firmware_metadatas_request']
+        # 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 = ['Bearer']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/deployments/firmware-metadatas', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='XiqFirmwareMetadatasResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)

extremecloudiq/api/configuration___network_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

extremecloudiq/api/configuration___policy_api.py

@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 24.3.1.2
+    The version of the OpenAPI document: 24.5.0.51
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """
@@ -5993,6 +5993,120 @@ class ConfigurationPolicyApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def get_radio_operating_modes(self, product_type, **kwargs):  # noqa: E501
+        """Get Radio Operating Modes by product type  # noqa: E501
+
+        Modern AP hardware types include dual or triple band radios.         A limited subset of band combinations are supported.         Operating mode defines the supported band combinations per radio.             Access Points with fixed band radios use GENERIC operating mode.           SERVICE_2_5_6:   wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz         SENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz         SERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz         SENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz         SERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz         SERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz.  # 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_radio_operating_modes(product_type, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str product_type: Product Type/Model (required)
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: list[XiqRadioOperatingModes]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.get_radio_operating_modes_with_http_info(product_type, **kwargs)  # noqa: E501
+
+    def get_radio_operating_modes_with_http_info(self, product_type, **kwargs):  # noqa: E501
+        """Get Radio Operating Modes by product type  # noqa: E501
+
+        Modern AP hardware types include dual or triple band radios.         A limited subset of band combinations are supported.         Operating mode defines the supported band combinations per radio.             Access Points with fixed band radios use GENERIC operating mode.           SERVICE_2_5_6:   wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz         SENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz         SERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz         SENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz         SERVICE_5L_5H_2: wifi0-5G Low, wifi1-5G High, wifi2-2.4Ghz         SERVICE_6L_5_6H: wifi0-6G Low, wifi1-5GHz, wifi2-6Ghz.  # 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_radio_operating_modes_with_http_info(product_type, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str product_type: Product Type/Model (required)
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: tuple(list[XiqRadioOperatingModes], status_code(int), headers(HTTPHeaderDict))
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'product_type'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_radio_operating_modes" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'product_type' is set
+        if self.api_client.client_side_validation and ('product_type' not in local_var_params or  # noqa: E501
+                                                        local_var_params['product_type'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `product_type` when calling `get_radio_operating_modes`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'product_type' in local_var_params:
+            path_params['productType'] = local_var_params['product_type']  # noqa: E501
+
+        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 = ['Bearer']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/radio-operating-modes/{productType}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[XiqRadioOperatingModes]',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def get_radio_profile(self, id, **kwargs):  # noqa: E501
         """Get radio profile by ID  # noqa: E501
 
@@ -7508,6 +7622,8 @@ class ConfigurationPolicyApi(object):
         :param async_req bool: execute request asynchronously
         :param int page: Page number, min = 1
         :param int limit: Page Size, min = 1, max = 100
+        :param XiqIotApplicationId app_id: Application ID, e.g. THREAD_GATEWAY
+        :param XiqIotApplicationSupported app_supported: Application Supported, e.g. SINGLE or MULTI
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -7534,6 +7650,8 @@ class ConfigurationPolicyApi(object):
         :param async_req bool: execute request asynchronously
         :param int page: Page number, min = 1
         :param int limit: Page Size, min = 1, max = 100
+        :param XiqIotApplicationId app_id: Application ID, e.g. THREAD_GATEWAY
+        :param XiqIotApplicationSupported app_supported: Application Supported, e.g. SINGLE or MULTI
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -7552,7 +7670,9 @@ class ConfigurationPolicyApi(object):
 
         all_params = [
             'page',
-            'limit'
+            'limit',
+            'app_id',
+            'app_supported'
         ]
         all_params.extend(
             [
@@ -7587,6 +7707,10 @@ class ConfigurationPolicyApi(object):
             query_params.append(('page', local_var_params['page']))  # noqa: E501
         if 'limit' in local_var_params and local_var_params['limit'] is not None:  # noqa: E501
             query_params.append(('limit', local_var_params['limit']))  # noqa: E501
+        if 'app_id' in local_var_params and local_var_params['app_id'] is not None:  # noqa: E501
+            query_params.append(('appId', local_var_params['app_id']))  # noqa: E501
+        if 'app_supported' in local_var_params and local_var_params['app_supported'] is not None:  # noqa: E501
+            query_params.append(('appSupported', local_var_params['app_supported']))  # noqa: E501
 
         header_params = {}