Upload new version of API

extremenetworks · Aug 28, 2023 · 283fd91 · 283fd91
1 parent 17d4292
commit 283fd91
Show file tree

Hide file tree

Showing 863 changed files with 2,792 additions and 856 deletions.
diff --git a/.openapi-generator/openapi.yaml.sha256 b/.openapi-generator/openapi.yaml.sha256
@@ -1 +1 @@
-6a3799fa092758233757ce90b64f9b1c62018126b25cacd1f5edb76a844783dd
+e2020b4e40727c0a3122468fe242fdf7d8140d83f51357eea68a13ab802f491d
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@ ExtremeCloud IQ RESTful API for external and internal applications.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 23.4.1.4
-- Package version: 23.4.1.4
+- API version: 23.5.0.41
+- Package version: 23.5.0.41
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.extremenetworks.com/support](https://www.extremenetworks.com/support)
 
@@ -321,6 +321,8 @@ Class | Method | HTTP request | Description
 *LocationApi* | [**delete_building**](docs/LocationApi.md#delete_building) | **DELETE** /locations/building/{id} | Delete building by ID
 *LocationApi* | [**delete_floor**](docs/LocationApi.md#delete_floor) | **DELETE** /locations/floor/{id} | Delete floor by ID
 *LocationApi* | [**delete_location**](docs/LocationApi.md#delete_location) | **DELETE** /locations/{id} | Delete location by ID
+*LocationApi* | [**get_location_devices_list**](docs/LocationApi.md#get_location_devices_list) | **GET** /locations/tree/devices | Get devices on the location hierarchy.
+*LocationApi* | [**get_location_maps_list**](docs/LocationApi.md#get_location_maps_list) | **GET** /locations/tree/maps | Get maps on the location hierarchy.
 *LocationApi* | [**get_location_tree**](docs/LocationApi.md#get_location_tree) | **GET** /locations/tree | Get location tree
 *LocationApi* | [**initialize_location**](docs/LocationApi.md#initialize_location) | **POST** /locations/:init | Initialize organization location
 *LocationApi* | [**update_building**](docs/LocationApi.md#update_building) | **PUT** /locations/building/{id} | Update building
@@ -387,6 +389,8 @@ Class | Method | HTTP request | Description
  - [PagedXiqInternalRadiusDevice](docs/PagedXiqInternalRadiusDevice.md)
  - [PagedXiqInternalRadiusServer](docs/PagedXiqInternalRadiusServer.md)
  - [PagedXiqLdapServer](docs/PagedXiqLdapServer.md)
+ - [PagedXiqLocationTreeDevice](docs/PagedXiqLocationTreeDevice.md)
+ - [PagedXiqLocationTreeMap](docs/PagedXiqLocationTreeMap.md)
  - [PagedXiqNetworkPolicy](docs/PagedXiqNetworkPolicy.md)
  - [PagedXiqRadioProfile](docs/PagedXiqRadioProfile.md)
  - [PagedXiqRadiusClientObject](docs/PagedXiqRadiusClientObject.md)
@@ -603,6 +607,8 @@ Class | Method | HTTP request | Description
  - [XiqLicenseStatus](docs/XiqLicenseStatus.md)
  - [XiqLocation](docs/XiqLocation.md)
  - [XiqLocationLegend](docs/XiqLocationLegend.md)
+ - [XiqLocationTreeDevice](docs/XiqLocationTreeDevice.md)
+ - [XiqLocationTreeMap](docs/XiqLocationTreeMap.md)
  - [XiqLocationType](docs/XiqLocationType.md)
  - [XiqLoginRequest](docs/XiqLoginRequest.md)
  - [XiqLoginResponse](docs/XiqLoginResponse.md)

diff --git a/docs/AuthorizationApi.md b/docs/AuthorizationApi.md
@@ -82,8 +82,8 @@ Name | Type | Description  | Notes
 **401** | Unauthorized |  -  |
 **400** | Bad Request |  -  |
 **500** | Internal Server Error |  -  |
-**200** | Successful operation |  -  |
 **403** | Access Denied |  -  |
+**200** | Successful operation |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

diff --git a/docs/LocationApi.md b/docs/LocationApi.md
@@ -10,6 +10,8 @@ Method | HTTP request | Description
 [**delete_building**](LocationApi.md#delete_building) | **DELETE** /locations/building/{id} | Delete building by ID
 [**delete_floor**](LocationApi.md#delete_floor) | **DELETE** /locations/floor/{id} | Delete floor by ID
 [**delete_location**](LocationApi.md#delete_location) | **DELETE** /locations/{id} | Delete location by ID
+[**get_location_devices_list**](LocationApi.md#get_location_devices_list) | **GET** /locations/tree/devices | Get devices on the location hierarchy.
+[**get_location_maps_list**](LocationApi.md#get_location_maps_list) | **GET** /locations/tree/maps | Get maps on the location hierarchy.
 [**get_location_tree**](LocationApi.md#get_location_tree) | **GET** /locations/tree | Get location tree
 [**initialize_location**](LocationApi.md#initialize_location) | **POST** /locations/:init | Initialize organization location
 [**update_building**](LocationApi.md#update_building) | **PUT** /locations/building/{id} | Update building
@@ -470,6 +472,168 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **get_location_devices_list**
+> PagedXiqLocationTreeDevice get_location_devices_list(page=page, limit=limit, location_id=location_id, expand_children=expand_children)
+
+Get devices on the location hierarchy.
+
+Get devices on the location hierarchy with pagination.
+
+### Example
+
+* Bearer (JWT) Authentication (BearerAuth):
+```python
+from __future__ import print_function
+import time
+import extremecloudiq
+from extremecloudiq.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost:8081
+# See configuration.py for a list of all supported configuration parameters.
+configuration = extremecloudiq.Configuration(
+    host = "http://localhost:8081"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): BearerAuth
+configuration = extremecloudiq.Configuration(
+    access_token = 'YOUR_BEARER_TOKEN'
+)
+
+# Enter a context with an instance of the API client
+with extremecloudiq.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = extremecloudiq.LocationApi(api_client)
+    page = 1 # int | Page number, min = 1 (optional) (default to 1)
+limit = 10 # int | Page Size, min = 1, max = 100 (optional) (default to 10)
+location_id = 56 # int | The location ID, or null for all locations. (optional)
+expand_children = True # bool | Whether to return the child locations recursively, default is true. Set it to false to improve performance when there are a lot of child locations. (optional) (default to True)
+
+    try:
+        # Get devices on the location hierarchy.
+        api_response = api_instance.get_location_devices_list(page=page, limit=limit, location_id=location_id, expand_children=expand_children)
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling LocationApi->get_location_devices_list: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **int**| Page number, min &#x3D; 1 | [optional] [default to 1]
+ **limit** | **int**| Page Size, min &#x3D; 1, max &#x3D; 100 | [optional] [default to 10]
+ **location_id** | **int**| The location ID, or null for all locations. | [optional] 
+ **expand_children** | **bool**| Whether to return the child locations recursively, default is true. Set it to false to improve performance when there are a lot of child locations. | [optional] [default to True]
+
+### Return type
+
+[**PagedXiqLocationTreeDevice**](PagedXiqLocationTreeDevice.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**401** | Unauthorized |  -  |
+**400** | Bad Request |  -  |
+**500** | Internal Server Error |  -  |
+**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_location_maps_list**
+> PagedXiqLocationTreeMap get_location_maps_list(page=page, limit=limit, location_id=location_id, expand_children=expand_children)
+
+Get maps on the location hierarchy.
+
+Get maps on the location hierarchy with pagination.
+
+### Example
+
+* Bearer (JWT) Authentication (BearerAuth):
+```python
+from __future__ import print_function
+import time
+import extremecloudiq
+from extremecloudiq.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to http://localhost:8081
+# See configuration.py for a list of all supported configuration parameters.
+configuration = extremecloudiq.Configuration(
+    host = "http://localhost:8081"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): BearerAuth
+configuration = extremecloudiq.Configuration(
+    access_token = 'YOUR_BEARER_TOKEN'
+)
+
+# Enter a context with an instance of the API client
+with extremecloudiq.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = extremecloudiq.LocationApi(api_client)
+    page = 1 # int | Page number, min = 1 (optional) (default to 1)
+limit = 10 # int | Page Size, min = 1, max = 100 (optional) (default to 10)
+location_id = 56 # int | The location ID, or null for all locations. (optional)
+expand_children = True # bool | Whether to return the child locations recursively, default is true. Set it to false to improve performance when there are a lot of child locations. (optional) (default to True)
+
+    try:
+        # Get maps on the location hierarchy.
+        api_response = api_instance.get_location_maps_list(page=page, limit=limit, location_id=location_id, expand_children=expand_children)
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling LocationApi->get_location_maps_list: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **int**| Page number, min &#x3D; 1 | [optional] [default to 1]
+ **limit** | **int**| Page Size, min &#x3D; 1, max &#x3D; 100 | [optional] [default to 10]
+ **location_id** | **int**| The location ID, or null for all locations. | [optional] 
+ **expand_children** | **bool**| Whether to return the child locations recursively, default is true. Set it to false to improve performance when there are a lot of child locations. | [optional] [default to True]
+
+### Return type
+
+[**PagedXiqLocationTreeMap**](PagedXiqLocationTreeMap.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**401** | Unauthorized |  -  |
+**400** | Bad Request |  -  |
+**500** | Internal Server Error |  -  |
+**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **get_location_tree**
 > list[XiqLocation] get_location_tree(parent_id=parent_id, expand_children=expand_children)
 

diff --git a/docs/PagedXiqLocationTreeDevice.md b/docs/PagedXiqLocationTreeDevice.md
@@ -0,0 +1,14 @@
+# PagedXiqLocationTreeDevice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **int** | The current page number | 
+**count** | **int** | The element count of the current page | 
+**total_pages** | **int** | The total page number based on request page size | 
+**total_count** | **int** | The total element count | 
+**data** | [**list[XiqLocationTreeDevice]**](XiqLocationTreeDevice.md) | The data in the current page | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/PagedXiqLocationTreeMap.md b/docs/PagedXiqLocationTreeMap.md
@@ -0,0 +1,14 @@
+# PagedXiqLocationTreeMap
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **int** | The current page number | 
+**count** | **int** | The element count of the current page | 
+**total_pages** | **int** | The total page number based on request page size | 
+**total_count** | **int** | The total element count | 
+**data** | [**list[XiqLocationTreeMap]**](XiqLocationTreeMap.md) | The data in the current page | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/XiqClient.md b/docs/XiqClient.md
@@ -47,6 +47,7 @@ Name | Type | Description | Notes
 **wing_ap** | **bool** | Wing ap flag | [optional] 
 **vendor** | **str** | The vendor of client | [optional] 
 **locations** | [**list[XiqLocationLegend]**](XiqLocationLegend.md) | The detailed location | [optional] 
+**product_type** | **str** | The Category which describes the Extreme device types(For example:For example:SR_2208P, AP_4000, AP_5010) | [optional] 
 **alias** | **str** | The alias of the client | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/XiqLocationTreeDevice.md b/docs/XiqLocationTreeDevice.md
@@ -0,0 +1,22 @@
+# XiqLocationTreeDevice
+
+The device on the location hierarchy.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**device_name** | **str** | The name of the device. | 
+**serial_number** | **str** | The device serial number. | [optional] 
+**mac_address** | **str** | The device MAC address. | 
+**device_function** | **str** | The device function, such as AP, Router, Switch, etc. | [optional] 
+**product_type** | **str** | The product type, such as: AP_230, BR_100, NX9600, etc. | [optional] 
+**ip_address** | **str** | The device IPv4 address. | [optional] 
+**location_id** | **int** | The location ID of the device on the location hierarchy. | [optional] 
+**map_name** | **str** | The associated background map for the device. | [optional] 
+**x** | **float** | The x-position of the device relative to the horizontal scale in meter. | [optional] 
+**y** | **float** | The y-position of the device relative to the vertical scale in meter. | [optional] 
+**scale_x** | **float** | The horizontal scale for the background map in meter. | [optional] 
+**scale_y** | **float** | The vertical scale for the background map in meter. | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/XiqLocationTreeMap.md b/docs/XiqLocationTreeMap.md
@@ -0,0 +1,14 @@
+# XiqLocationTreeMap
+
+The map on the location hierarchy.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**map_name** | **str** | The background map name. | 
+**width** | **float** | The x-dimension of the map in pixels. | [optional] 
+**height** | **float** | The y-dimension of the map in pixels. | [optional] 
+**data** | **str** | The base-64 encoded string of the map. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/extremecloudiq/__init__.py b/extremecloudiq/__init__.py
@@ -7,15 +7,15 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 23.4.1.4
+    The version of the OpenAPI document: 23.5.0.41
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """
 
 
 from __future__ import absolute_import
 
-__version__ = "23.4.1.4"
+__version__ = "23.5.0.41"
 
 # import apis into sdk package
 from extremecloudiq.api.account_api import AccountApi
@@ -75,6 +75,8 @@
 from extremecloudiq.models.paged_xiq_internal_radius_device import PagedXiqInternalRadiusDevice
 from extremecloudiq.models.paged_xiq_internal_radius_server import PagedXiqInternalRadiusServer
 from extremecloudiq.models.paged_xiq_ldap_server import PagedXiqLdapServer
+from extremecloudiq.models.paged_xiq_location_tree_device import PagedXiqLocationTreeDevice
+from extremecloudiq.models.paged_xiq_location_tree_map import PagedXiqLocationTreeMap
 from extremecloudiq.models.paged_xiq_network_policy import PagedXiqNetworkPolicy
 from extremecloudiq.models.paged_xiq_radio_profile import PagedXiqRadioProfile
 from extremecloudiq.models.paged_xiq_radius_client_object import PagedXiqRadiusClientObject
@@ -291,6 +293,8 @@
 from extremecloudiq.models.xiq_license_status import XiqLicenseStatus
 from extremecloudiq.models.xiq_location import XiqLocation
 from extremecloudiq.models.xiq_location_legend import XiqLocationLegend
+from extremecloudiq.models.xiq_location_tree_device import XiqLocationTreeDevice
+from extremecloudiq.models.xiq_location_tree_map import XiqLocationTreeMap
 from extremecloudiq.models.xiq_location_type import XiqLocationType
 from extremecloudiq.models.xiq_login_request import XiqLoginRequest
 from extremecloudiq.models.xiq_login_response import XiqLoginResponse

diff --git a/extremecloudiq/api/account_api.py b/extremecloudiq/api/account_api.py
@@ -5,7 +5,7 @@
 
     ExtremeCloud IQ RESTful API for external and internal applications.  # noqa: E501
 
-    The version of the OpenAPI document: 23.4.1.4
+    The version of the OpenAPI document: 23.5.0.41
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

diff --git a/extremecloudiq/api/alert_api.py b/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: 23.4.1.4
+    The version of the OpenAPI document: 23.5.0.41
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

diff --git a/extremecloudiq/api/application_api.py b/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: 23.4.1.4
+    The version of the OpenAPI document: 23.5.0.41
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

diff --git a/extremecloudiq/api/authentication_api.py b/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: 23.4.1.4
+    The version of the OpenAPI document: 23.5.0.41
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

diff --git a/extremecloudiq/api/authorization_api.py b/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: 23.4.1.4
+    The version of the OpenAPI document: 23.5.0.41
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """

diff --git a/extremecloudiq/api/client_api.py b/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: 23.4.1.4
+    The version of the OpenAPI document: 23.5.0.41
     Contact: support@extremenetworks.com
     Generated by: https://openapi-generator.tech
 """
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		6a3799fa092758233757ce90b64f9b1c62018126b25cacd1f5edb76a844783dd
		e2020b4e40727c0a3122468fe242fdf7d8140d83f51357eea68a13ab802f491d