Skip to content

Commit

Permalink
Upload new version of API
Browse files Browse the repository at this point in the history
  • Loading branch information
jenkins committed Jan 22, 2024
1 parent 42719d1 commit e44eff2
Show file tree
Hide file tree
Showing 1,039 changed files with 1,396 additions and 1,075 deletions.
2 changes: 1 addition & 1 deletion .openapi-generator/openapi.yaml.sha256
Original file line number Diff line number Diff line change
@@ -1 +1 @@
d453e0f520be6dfa3697be686d715bb6ba63cb4ea945f97fe80c776df7129c2d
1662f78b29d89bf70503067db1c42c6e9b7f759c2a502412d64f2fd10ba9cccc
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.0.64
- Package version: 23.7.0.64
- API version: 23.7.1.7
- Package version: 23.7.1.7
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.extremenetworks.com/support](https://www.extremenetworks.com/support)

Expand Down Expand Up @@ -283,6 +283,7 @@ Class | Method | HTTP request | Description
*CopilotAnomaliesApi* | [**update_anomaly_action**](docs/CopilotAnomaliesApi.md#update_anomaly_action) | **PUT** /copilot/anomalies/update-action |
*CopilotAnomaliesApi* | [**update_anomaly_device_action**](docs/CopilotAnomaliesApi.md#update_anomaly_device_action) | **PUT** /copilot/anomalies/devices/update-action |
*CopilotAnomaliesApi* | [**update_copilot_anomalies_devices_action**](docs/CopilotAnomaliesApi.md#update_copilot_anomalies_devices_action) | **PUT** /copilot/anomalies/update-device-action | [LRO] Update Anomalies and Devices
*CopilotConnectivityExperienceApi* | [**get_connectivity_details_by_client_type**](docs/CopilotConnectivityExperienceApi.md#get_connectivity_details_by_client_type) | **GET** /copilot/connectivity/client-type |
*CopilotConnectivityExperienceApi* | [**get_connectivity_details_by_locations**](docs/CopilotConnectivityExperienceApi.md#get_connectivity_details_by_locations) | **GET** /copilot/connectivity/locations |
*CopilotConnectivityExperienceApi* | [**get_wired_connectivity_experience**](docs/CopilotConnectivityExperienceApi.md#get_wired_connectivity_experience) | **GET** /copilot/connectivity/wired/experience |
*CopilotConnectivityExperienceApi* | [**get_wired_events**](docs/CopilotConnectivityExperienceApi.md#get_wired_events) | **GET** /copilot/connectivity/wired/events |
Expand Down Expand Up @@ -579,6 +580,7 @@ Class | Method | HTTP request | Description
- [XiqClientView](docs/XiqClientView.md)
- [XiqCloudConfigGroup](docs/XiqCloudConfigGroup.md)
- [XiqCloudSharkStorage](docs/XiqCloudSharkStorage.md)
- [XiqConnectivityDetailsByClientTypeResponse](docs/XiqConnectivityDetailsByClientTypeResponse.md)
- [XiqConnectivityExperienceData](docs/XiqConnectivityExperienceData.md)
- [XiqConnectivityExperienceViewType](docs/XiqConnectivityExperienceViewType.md)
- [XiqCopilotAnomaliesActionResponse](docs/XiqCopilotAnomaliesActionResponse.md)
Expand Down Expand Up @@ -770,6 +772,7 @@ Class | Method | HTTP request | Description
- [XiqPortEfficiencyStatsResponse](docs/XiqPortEfficiencyStatsResponse.md)
- [XiqPostExpirationAction](docs/XiqPostExpirationAction.md)
- [XiqPskGenerationMethod](docs/XiqPskGenerationMethod.md)
- [XiqQualityIndex](docs/XiqQualityIndex.md)
- [XiqRadio](docs/XiqRadio.md)
- [XiqRadioEntity](docs/XiqRadioEntity.md)
- [XiqRadioMode](docs/XiqRadioMode.md)
Expand Down Expand Up @@ -800,6 +803,8 @@ Class | Method | HTTP request | Description
- [XiqSetSsidModePskRequest](docs/XiqSetSsidModePskRequest.md)
- [XiqSetSsidModeWepRequest](docs/XiqSetSsidModeWepRequest.md)
- [XiqSite](docs/XiqSite.md)
- [XiqSitesByWiredEntity](docs/XiqSitesByWiredEntity.md)
- [XiqSitesByWirelessEntity](docs/XiqSitesByWirelessEntity.md)
- [XiqSmsLog](docs/XiqSmsLog.md)
- [XiqSmsLogStatus](docs/XiqSmsLogStatus.md)
- [XiqSmsTemplate](docs/XiqSmsTemplate.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/AuthorizationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ Name | Type | Description | Notes
**401** | Unauthorized | - |
**400** | Bad Request | - |
**500** | Internal Server Error | - |
**403** | Access Denied | - |
**200** | Successful operation | - |
**403** | Access Denied | - |

[[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)

Expand Down Expand Up @@ -300,8 +300,8 @@ This endpoint does not need any parameter.
**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)

Expand Down
89 changes: 87 additions & 2 deletions docs/CopilotConnectivityExperienceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ All URIs are relative to *http://localhost:8081*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_connectivity_details_by_client_type**](CopilotConnectivityExperienceApi.md#get_connectivity_details_by_client_type) | **GET** /copilot/connectivity/client-type |
[**get_connectivity_details_by_locations**](CopilotConnectivityExperienceApi.md#get_connectivity_details_by_locations) | **GET** /copilot/connectivity/locations |
[**get_wired_connectivity_experience**](CopilotConnectivityExperienceApi.md#get_wired_connectivity_experience) | **GET** /copilot/connectivity/wired/experience |
[**get_wired_events**](CopilotConnectivityExperienceApi.md#get_wired_events) | **GET** /copilot/connectivity/wired/events |
Expand All @@ -23,8 +24,88 @@ Method | HTTP request | Description
[**get_wireless_views**](CopilotConnectivityExperienceApi.md#get_wireless_views) | **GET** /copilot/connectivity/wireless/views |


# **get_connectivity_details_by_client_type**
> XiqConnectivityDetailsByClientTypeResponse get_connectivity_details_by_client_type(start_time, end_time, location_id=location_id, client_type=client_type, forensic_bucket=forensic_bucket)


### 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.CopilotConnectivityExperienceApi(api_client)
start_time = 56 # int | The start time to query, epoch time in milliseconds since 1/1/1970
end_time = 56 # int | The end time to query, epoch time in milliseconds since 1/1/1970
location_id = 0 # int | The location Id (optional) (default to 0)
client_type = extremecloudiq.XiqClientType() # XiqClientType | The client type (optional)
forensic_bucket = extremecloudiq.XiqForensicBucket() # XiqForensicBucket | The time period bucket detected (optional)

try:
api_response = api_instance.get_connectivity_details_by_client_type(start_time, end_time, location_id=location_id, client_type=client_type, forensic_bucket=forensic_bucket)
pprint(api_response)
except ApiException as e:
print("Exception when calling CopilotConnectivityExperienceApi->get_connectivity_details_by_client_type: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**start_time** | **int**| The start time to query, epoch time in milliseconds since 1/1/1970 |
**end_time** | **int**| The end time to query, epoch time in milliseconds since 1/1/1970 |
**location_id** | **int**| The location Id | [optional] [default to 0]
**client_type** | [**XiqClientType**](.md)| The client type | [optional]
**forensic_bucket** | [**XiqForensicBucket**](.md)| The time period bucket detected | [optional]

### Return type

[**XiqConnectivityDetailsByClientTypeResponse**](XiqConnectivityDetailsByClientTypeResponse.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_connectivity_details_by_locations**
> PagedXiqConnectivityExperienceData get_connectivity_details_by_locations(start_time, end_time, page=page, limit=limit, sort_field=sort_field, sort_order=sort_order, location_id=location_id, search_key=search_key, client_type=client_type)
> PagedXiqConnectivityExperienceData get_connectivity_details_by_locations(start_time, end_time, page=page, limit=limit, sort_field=sort_field, sort_order=sort_order, location_id=location_id, search_key=search_key, client_type=client_type, forensic_bucket=forensic_bucket, quality_index=quality_index)


Expand Down Expand Up @@ -66,9 +147,11 @@ sort_order = extremecloudiq.XiqSortOrder() # XiqSortOrder | The sorting order (o
location_id = 0 # int | The location Id (optional) (default to 0)
search_key = '' # str | The search value (optional) (default to '')
client_type = extremecloudiq.XiqClientType() # XiqClientType | The client type (optional)
forensic_bucket = extremecloudiq.XiqForensicBucket() # XiqForensicBucket | The time period bucket detected (optional)
quality_index = extremecloudiq.XiqQualityIndex() # XiqQualityIndex | The quality index value (optional)

try:
api_response = api_instance.get_connectivity_details_by_locations(start_time, end_time, page=page, limit=limit, sort_field=sort_field, sort_order=sort_order, location_id=location_id, search_key=search_key, client_type=client_type)
api_response = api_instance.get_connectivity_details_by_locations(start_time, end_time, page=page, limit=limit, sort_field=sort_field, sort_order=sort_order, location_id=location_id, search_key=search_key, client_type=client_type, forensic_bucket=forensic_bucket, quality_index=quality_index)
pprint(api_response)
except ApiException as e:
print("Exception when calling CopilotConnectivityExperienceApi->get_connectivity_details_by_locations: %s\n" % e)
Expand All @@ -87,6 +170,8 @@ Name | Type | Description | Notes
**location_id** | **int**| The location Id | [optional] [default to 0]
**search_key** | **str**| The search value | [optional] [default to '']
**client_type** | [**XiqClientType**](.md)| The client type | [optional]
**forensic_bucket** | [**XiqForensicBucket**](.md)| The time period bucket detected | [optional]
**quality_index** | [**XiqQualityIndex**](.md)| The quality index value | [optional]

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/XiqConnectivityExperienceData.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**info** | **str** | the info related to connectivity experience view type | [optional]
**name** | **str** | the location/ssid/os-name based on view type |
**quality_index** | **int** | the quality index |
**quality_index_value** | [**XiqQualityIndex**](XiqQualityIndex.md) | |
**client_type** | [**XiqClientType**](XiqClientType.md) | |
**trend_indicator** | [**XiqTrendIndicator**](XiqTrendIndicator.md) | |
**quality_index_graph** | [**list[XiqDataPoint]**](XiqDataPoint.md) | the quality index graph |
Expand Down
4 changes: 2 additions & 2 deletions docs/XiqCreateSiteRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**parent_id** | **int** | The parent site ID |
**parent_id** | **int** | The parent site group ID |
**name** | **str** | The site name |
**address** | [**XiqAddress**](XiqAddress.md) | | [optional]
**country_code** | **int** | The site country code. Get the list of country codes from /countries XAPI. | [optional]
**country_code** | **int** | The site country code. Get the list of country codes from /countries XAPI. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/XiqExternalUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**user_role** | [**XiqUserRole**](XiqUserRole.md) | |
**org_id** | **int** | The HIQ organization ID if it is HIQ user. | [optional]
**location_ids** | **list[int]** | The assigned location IDs. | [optional]
**grantee_id** | **int** | The home VIQ user ID of external user. | [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)

Expand Down
8 changes: 4 additions & 4 deletions docs/XiqSite.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Name | Type | Description | Notes
**create_time** | **datetime** | The create time |
**update_time** | **datetime** | The last update time |
**org_id** | **int** | The organization identifier, valid when enabling HIQ feature | [optional]
**parent_id** | **int** | The parent site ID | [optional]
**parent_id** | **int** | The parent site group ID |
**name** | **str** | The site name |
**unique_name** | **str** | The unique site name |
**type** | **str** | The site type |
**unique_name** | **str** | The site unique name |
**type** | **str** | The location type |
**address** | [**XiqAddress**](XiqAddress.md) | | [optional]
**country_code** | **int** | The country code for the site | [optional]
**country_code** | **int** | The country code for the site |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/XiqUpdateSiteRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**parent_id** | **int** | The parent location ID |
**parent_id** | **int** | The parent site group ID |
**name** | **str** | The site name |
**address** | [**XiqAddress**](XiqAddress.md) | | [optional]
**country_code** | **int** | The site country code. Get the list of country codes from /countries XAPI. | [optional]
**country_code** | **int** | The site country code. Get the list of country codes from /countries XAPI. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
8 changes: 6 additions & 2 deletions extremecloudiq/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""


from __future__ import absolute_import

__version__ = "23.7.0.64"
__version__ = "23.7.1.7"

# import apis into sdk package
from extremecloudiq.api.account_api import AccountApi
Expand Down Expand Up @@ -203,6 +203,7 @@
from extremecloudiq.models.xiq_client_view import XiqClientView
from extremecloudiq.models.xiq_cloud_config_group import XiqCloudConfigGroup
from extremecloudiq.models.xiq_cloud_shark_storage import XiqCloudSharkStorage
from extremecloudiq.models.xiq_connectivity_details_by_client_type_response import XiqConnectivityDetailsByClientTypeResponse
from extremecloudiq.models.xiq_connectivity_experience_data import XiqConnectivityExperienceData
from extremecloudiq.models.xiq_connectivity_experience_view_type import XiqConnectivityExperienceViewType
from extremecloudiq.models.xiq_copilot_anomalies_action_response import XiqCopilotAnomaliesActionResponse
Expand Down Expand Up @@ -394,6 +395,7 @@
from extremecloudiq.models.xiq_port_efficiency_stats_response import XiqPortEfficiencyStatsResponse
from extremecloudiq.models.xiq_post_expiration_action import XiqPostExpirationAction
from extremecloudiq.models.xiq_psk_generation_method import XiqPskGenerationMethod
from extremecloudiq.models.xiq_quality_index import XiqQualityIndex
from extremecloudiq.models.xiq_radio import XiqRadio
from extremecloudiq.models.xiq_radio_entity import XiqRadioEntity
from extremecloudiq.models.xiq_radio_mode import XiqRadioMode
Expand Down Expand Up @@ -424,6 +426,8 @@
from extremecloudiq.models.xiq_set_ssid_mode_psk_request import XiqSetSsidModePskRequest
from extremecloudiq.models.xiq_set_ssid_mode_wep_request import XiqSetSsidModeWepRequest
from extremecloudiq.models.xiq_site import XiqSite
from extremecloudiq.models.xiq_sites_by_wired_entity import XiqSitesByWiredEntity
from extremecloudiq.models.xiq_sites_by_wireless_entity import XiqSitesByWirelessEntity
from extremecloudiq.models.xiq_sms_log import XiqSmsLog
from extremecloudiq.models.xiq_sms_log_status import XiqSmsLogStatus
from extremecloudiq.models.xiq_sms_template import XiqSmsTemplate
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/account_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/alert_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/application_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/authentication_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/authorization_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/client_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/configuration___authentication_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/configuration___basic_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/configuration___certificate_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion extremecloudiq/api/configuration___deployment_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ExtremeCloud IQ RESTful API for external and internal applications. # noqa: E501
The version of the OpenAPI document: 23.7.0.64
The version of the OpenAPI document: 23.7.1.7
Contact: support@extremenetworks.com
Generated by: https://openapi-generator.tech
"""
Expand Down
Loading

0 comments on commit e44eff2

Please sign in to comment.