Metadata-Version: 2.1
Name: RuckusVirtualSmartZoneAPIClient
Version: 0.0.1
Summary: An API Client to use the Virtual SmartZone - High Scale Public API.
Home-page: https://github.com/vsantiago113/RuckusVirtualSmartZoneAPIClient
Author: Victor M Santiago
Author-email: vsantiago113sec@gmail.com
License: MIT
Download-URL: https://github.com/vsantiago113/RuckusVirtualSmartZoneAPIClient/archive/0.0.1.tar.gz
Description: # RuckusVirtualSmartZoneAPIClient
        [Ruckus - Virtual SmartZone - High Scale Public API Reference Guide](http://docs.ruckuswireless.com/smartzone/5.2.1/vszh-public-api-reference-guide-521.html 'Ruckus - Virtual SmartZone - High Scale Public API Reference Guide')<br />
        
        ---
        
        An API Client for the Virtual SmartZone - High Scale Public API Reference Guide to be able to easily use the API in a more standard way.
        
        ## How to install
        ```ignorelang
        $ pip install RuckusVirtualSmartZoneAPIClient
        ```
        
        ## Usage
        The argument 'method' must be specify every time.
        
        #### Default arguments and attributes
        ```python
        import RuckusVirtualSmartZoneAPIClient
        
        client = RuckusVirtualSmartZoneAPIClient.Client(verify=False, warnings=False, api_version='v9_1')
        
        client.get(url=None, method='', data=None, auth = None)
        
        # client.headers
        # client.base_url
        # client.token
        # client.auth
        # client.server
        
        ```
        
        #### Authentication
        ```python
        import RuckusVirtualSmartZoneAPIClient
        
        client = RuckusVirtualSmartZoneAPIClient.Client()
        client.connect(url='https://localhost:8443', username='admin', password='Admin123')
        
        client.disconnect()
        ```
        
        #### The first query
        ```python
        import RuckusVirtualSmartZoneAPIClient
        import json
        
        client = RuckusVirtualSmartZoneAPIClient.Client()
        client.connect(url='https://localhost:8443', username='admin', password='Admin123')
        
        response = client.get(method='/domains')
        print(json.dumps(response.json(), indent=4))
        
        client.disconnect()
        ```
        
        #### Creating
        ```python
        import RuckusVirtualSmartZoneAPIClient
        import json
        
        client = RuckusVirtualSmartZoneAPIClient.Client()
        client.connect(url='https://localhost:8443', username='admin', password='Admin123')
        
        response = client.post(method='/domains', data={'name': 'TestDomain'})
        domain_id = response.json()['id']
        print(json.dumps(response.json(), indent=4)) # --> 201
        
        client.disconnect()
        ```
        
        #### Updating
        ```python
        import RuckusVirtualSmartZoneAPIClient
        import json
        
        client = RuckusVirtualSmartZoneAPIClient.Client()
        client.connect(url='https://localhost:8443', username='admin', password='Admin123')
        
        domain_id = '1234567890asdfg'
        response = client.patch(method=f'/domains/{domain_id}', data={'description': 'I updated this description.'})
        print(response.status_code) # --> 204
        
        client.disconnect()
        ```
        
        #### Deleting
        ```python
        import RuckusVirtualSmartZoneAPIClient
        
        client = RuckusVirtualSmartZoneAPIClient.Client()
        client.connect(url='https://localhost:8443', username='admin', password='Admin123')
        
        domain_id = '1234567890asdfg'
        response = client.delete(method=f'/domains/{domain_id}')
        print(response.status_code) # --> 204
        
        client.disconnect()
        ```
        
Keywords: ruckus,virtual smartzone,high scale
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.4.0
Description-Content-Type: text/markdown
