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

extremecloudiq/api/configuration___user_management_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,7 +38,7 @@ class ConfigurationUserManagementApi(object):
         self.api_client = api_client
 
     def add_key_based_pcg_users(self, policy_id, xiq_create_key_based_pcg_users_request, **kwargs):  # noqa: E501
-        """Add users to a PCG-enabled network policy  # noqa: E501
+        """[LRO] Add users to a PCG-enabled network policy  # noqa: E501
 
         Add users to a PCG-enabled network policy.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -49,6 +49,7 @@ class ConfigurationUserManagementApi(object):
         :param async_req bool: execute request asynchronously
         :param int policy_id: The network policy ID (required)
         :param XiqCreateKeyBasedPcgUsersRequest xiq_create_key_based_pcg_users_request: The payload of add users to PCG-enabled network policy (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.
@@ -56,7 +57,7 @@ class ConfigurationUserManagementApi(object):
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
-        :return: None
+        :return: XiqCreateKeyBasedPcgUsersResponse
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -64,7 +65,7 @@ class ConfigurationUserManagementApi(object):
         return self.add_key_based_pcg_users_with_http_info(policy_id, xiq_create_key_based_pcg_users_request, **kwargs)  # noqa: E501
 
     def add_key_based_pcg_users_with_http_info(self, policy_id, xiq_create_key_based_pcg_users_request, **kwargs):  # noqa: E501
-        """Add users to a PCG-enabled network policy  # noqa: E501
+        """[LRO] Add users to a PCG-enabled network policy  # noqa: E501
 
         Add users to a PCG-enabled network policy.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -75,6 +76,7 @@ class ConfigurationUserManagementApi(object):
         :param async_req bool: execute request asynchronously
         :param int policy_id: The network policy ID (required)
         :param XiqCreateKeyBasedPcgUsersRequest xiq_create_key_based_pcg_users_request: The payload of add users to PCG-enabled network policy (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
@@ -84,7 +86,7 @@ class ConfigurationUserManagementApi(object):
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
-        :return: None
+        :return: tuple(XiqCreateKeyBasedPcgUsersResponse, status_code(int), headers(HTTPHeaderDict))
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -93,7 +95,8 @@ class ConfigurationUserManagementApi(object):
 
         all_params = [
             'policy_id',
-            'xiq_create_key_based_pcg_users_request'
+            'xiq_create_key_based_pcg_users_request',
+            '_async'
         ]
         all_params.extend(
             [
@@ -128,6 +131,8 @@ class ConfigurationUserManagementApi(object):
             path_params['policyId'] = local_var_params['policy_id']  # noqa: E501
 
         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 = {}
 
@@ -156,7 +161,7 @@ class ConfigurationUserManagementApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type=None,  # noqa: E501
+            response_type='XiqCreateKeyBasedPcgUsersResponse',  # 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
@@ -409,6 +414,129 @@ class ConfigurationUserManagementApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def create_key_based_pcg_network_policy(self, xiq_init_key_based_pcg_network_policy_request, **kwargs):  # noqa: E501
+        """[LRO] Create a Key-based Private Client Group  # noqa: E501
+
+        Create a Key-based Private Client Group, including network policy, user, user group, SSID, etc.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.create_key_based_pcg_network_policy(xiq_init_key_based_pcg_network_policy_request, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param XiqInitKeyBasedPcgNetworkPolicyRequest xiq_init_key_based_pcg_network_policy_request: The request to create Key-based PCG network policy (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.
+        :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: XiqKeyBasedPcg
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.create_key_based_pcg_network_policy_with_http_info(xiq_init_key_based_pcg_network_policy_request, **kwargs)  # noqa: E501
+
+    def create_key_based_pcg_network_policy_with_http_info(self, xiq_init_key_based_pcg_network_policy_request, **kwargs):  # noqa: E501
+        """[LRO] Create a Key-based Private Client Group  # noqa: E501
+
+        Create a Key-based Private Client Group, including network policy, user, user group, SSID, etc.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.create_key_based_pcg_network_policy_with_http_info(xiq_init_key_based_pcg_network_policy_request, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param XiqInitKeyBasedPcgNetworkPolicyRequest xiq_init_key_based_pcg_network_policy_request: The request to create Key-based PCG network policy (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
+                                 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(XiqKeyBasedPcg, status_code(int), headers(HTTPHeaderDict))
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'xiq_init_key_based_pcg_network_policy_request',
+            '_async'
+        ]
+        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 create_key_based_pcg_network_policy" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'xiq_init_key_based_pcg_network_policy_request' is set
+        if self.api_client.client_side_validation and ('xiq_init_key_based_pcg_network_policy_request' not in local_var_params or  # noqa: E501
+                                                        local_var_params['xiq_init_key_based_pcg_network_policy_request'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `xiq_init_key_based_pcg_network_policy_request` when calling `create_key_based_pcg_network_policy`")  # noqa: E501
+
+        collection_formats = {}
+
+        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 = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'xiq_init_key_based_pcg_network_policy_request' in local_var_params:
+            body_params = local_var_params['xiq_init_key_based_pcg_network_policy_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(
+            '/pcgs/key-based', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='XiqKeyBasedPcg',  # 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 create_user_group(self, xiq_create_user_group_request, **kwargs):  # noqa: E501
         """Create user group  # noqa: E501
 
@@ -2072,9 +2200,9 @@ class ConfigurationUserManagementApi(object):
             collection_formats=collection_formats)
 
     def onboard_key_based_private_client_group(self, policy_id, xiq_onboard_key_based_pcg_request, **kwargs):  # noqa: E501
-        """Create Key-based PCG in network policy  # noqa: E501
+        """[LRO] Onboard Key-based PCG in network policy  # noqa: E501
 
-        Create a Key-based Private Client Group for a specific network policy.  # noqa: E501
+        Onboard a Key-based Private Client Group for a specific network policy.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.onboard_key_based_private_client_group(policy_id, xiq_onboard_key_based_pcg_request, async_req=True)
@@ -2083,6 +2211,7 @@ class ConfigurationUserManagementApi(object):
         :param async_req bool: execute request asynchronously
         :param int policy_id: The network policy ID (required)
         :param XiqOnboardKeyBasedPcgRequest xiq_onboard_key_based_pcg_request: (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.
@@ -2090,7 +2219,7 @@ class ConfigurationUserManagementApi(object):
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
-        :return: None
+        :return: XiqOnboardKeyBasedPcgResponse
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -2098,9 +2227,9 @@ class ConfigurationUserManagementApi(object):
         return self.onboard_key_based_private_client_group_with_http_info(policy_id, xiq_onboard_key_based_pcg_request, **kwargs)  # noqa: E501
 
     def onboard_key_based_private_client_group_with_http_info(self, policy_id, xiq_onboard_key_based_pcg_request, **kwargs):  # noqa: E501
-        """Create Key-based PCG in network policy  # noqa: E501
+        """[LRO] Onboard Key-based PCG in network policy  # noqa: E501
 
-        Create a Key-based Private Client Group for a specific network policy.  # noqa: E501
+        Onboard a Key-based Private Client Group for a specific network policy.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.onboard_key_based_private_client_group_with_http_info(policy_id, xiq_onboard_key_based_pcg_request, async_req=True)
@@ -2109,6 +2238,7 @@ class ConfigurationUserManagementApi(object):
         :param async_req bool: execute request asynchronously
         :param int policy_id: The network policy ID (required)
         :param XiqOnboardKeyBasedPcgRequest xiq_onboard_key_based_pcg_request: (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
@@ -2118,7 +2248,7 @@ class ConfigurationUserManagementApi(object):
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
-        :return: None
+        :return: tuple(XiqOnboardKeyBasedPcgResponse, status_code(int), headers(HTTPHeaderDict))
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -2127,7 +2257,8 @@ class ConfigurationUserManagementApi(object):
 
         all_params = [
             'policy_id',
-            'xiq_onboard_key_based_pcg_request'
+            'xiq_onboard_key_based_pcg_request',
+            '_async'
         ]
         all_params.extend(
             [
@@ -2162,6 +2293,8 @@ class ConfigurationUserManagementApi(object):
             path_params['policyId'] = local_var_params['policy_id']  # noqa: E501
 
         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 = {}
 
@@ -2190,7 +2323,7 @@ class ConfigurationUserManagementApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type=None,  # noqa: E501
+            response_type='XiqOnboardKeyBasedPcgResponse',  # 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
@@ -2312,124 +2445,6 @@ class ConfigurationUserManagementApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def setup_key_based_private_client_group_network_policy(self, xiq_init_key_based_pcg_network_policy_request, **kwargs):  # noqa: E501
-        """Setup a Key-based Private Client Group  # noqa: E501
-
-        Setup a Key-based Private Client Group, including network policy, user, user group, SSID, etc.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.setup_key_based_private_client_group_network_policy(xiq_init_key_based_pcg_network_policy_request, async_req=True)
-        >>> result = thread.get()
-
-        :param async_req bool: execute request asynchronously
-        :param XiqInitKeyBasedPcgNetworkPolicyRequest xiq_init_key_based_pcg_network_policy_request: The request to setup Key-based PCG network policy (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: None
-                 If the method is called asynchronously,
-                 returns the request thread.
-        """
-        kwargs['_return_http_data_only'] = True
-        return self.setup_key_based_private_client_group_network_policy_with_http_info(xiq_init_key_based_pcg_network_policy_request, **kwargs)  # noqa: E501
-
-    def setup_key_based_private_client_group_network_policy_with_http_info(self, xiq_init_key_based_pcg_network_policy_request, **kwargs):  # noqa: E501
-        """Setup a Key-based Private Client Group  # noqa: E501
-
-        Setup a Key-based Private Client Group, including network policy, user, user group, SSID, etc.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.setup_key_based_private_client_group_network_policy_with_http_info(xiq_init_key_based_pcg_network_policy_request, async_req=True)
-        >>> result = thread.get()
-
-        :param async_req bool: execute request asynchronously
-        :param XiqInitKeyBasedPcgNetworkPolicyRequest xiq_init_key_based_pcg_network_policy_request: The request to setup Key-based PCG network policy (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: None
-                 If the method is called asynchronously,
-                 returns the request thread.
-        """
-
-        local_var_params = locals()
-
-        all_params = [
-            'xiq_init_key_based_pcg_network_policy_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 setup_key_based_private_client_group_network_policy" % key
-                )
-            local_var_params[key] = val
-        del local_var_params['kwargs']
-        # verify the required parameter 'xiq_init_key_based_pcg_network_policy_request' is set
-        if self.api_client.client_side_validation and ('xiq_init_key_based_pcg_network_policy_request' not in local_var_params or  # noqa: E501
-                                                        local_var_params['xiq_init_key_based_pcg_network_policy_request'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `xiq_init_key_based_pcg_network_policy_request` when calling `setup_key_based_private_client_group_network_policy`")  # noqa: E501
-
-        collection_formats = {}
-
-        path_params = {}
-
-        query_params = []
-
-        header_params = {}
-
-        form_params = []
-        local_var_files = {}
-
-        body_params = None
-        if 'xiq_init_key_based_pcg_network_policy_request' in local_var_params:
-            body_params = local_var_params['xiq_init_key_based_pcg_network_policy_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(
-            '/pcgs/key-based', 'POST',
-            path_params,
-            query_params,
-            header_params,
-            body=body_params,
-            post_params=form_params,
-            files=local_var_files,
-            response_type=None,  # 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 update_end_user(self, id, xiq_update_end_user_request, **kwargs):  # noqa: E501
         """Update an end user  # noqa: E501