# peplink-api-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.1
- Package version: 1.0.0
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import peplink_api_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import peplink_api_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import peplink_api_client
from peplink_api_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = peplink_api_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with peplink_api_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = peplink_api_client.DefaultApi(api_client)
token_request = peplink_api_client.TokenRequest() # TokenRequest | (optional)
try:
# Generate a new access token
api_response = api_instance.api_auth_token_grant_post(token_request=token_request)
print("The response of DefaultApi->api_auth_token_grant_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->api_auth_token_grant_post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**api_auth_token_grant_post**](docs/DefaultApi.md#api_auth_token_grant_post) | **POST** /api/auth.token.grant | Generate a new access token
*DefaultApi* | [**api_status_wan_connection_get**](docs/DefaultApi.md#api_status_wan_connection_get) | **GET** /api/status.wan.connection | Get WAN status
## Documentation For Models
- [BWAllowanceMonitorObj](docs/BWAllowanceMonitorObj.md)
- [BandObj](docs/BandObj.md)
- [CarrierObj](docs/CarrierObj.md)
- [CellTowerObj](docs/CellTowerObj.md)
- [GobiObj](docs/GobiObj.md)
- [MEIDObj](docs/MEIDObj.md)
- [ModemObj](docs/ModemObj.md)
- [MonthlyAllowanceObj](docs/MonthlyAllowanceObj.md)
- [RATObj](docs/RATObj.md)
- [RemoteSIMObj](docs/RemoteSIMObj.md)
- [RoamingObj](docs/RoamingObj.md)
- [SIMGroupObj](docs/SIMGroupObj.md)
- [SIMObj](docs/SIMObj.md)
- [SignalObj](docs/SignalObj.md)
- [TokenRequest](docs/TokenRequest.md)
- [TokenResponse](docs/TokenResponse.md)
- [WanStatusResponse](docs/WanStatusResponse.md)
- [WanStatusResponseResponseValue](docs/WanStatusResponseResponseValue.md)
- [WifiObj](docs/WifiObj.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "peplink_api_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Peplink API",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/5e/ef/b6ed4852ffc4fe54db482b8f58a05b4d21eec4317d76dfdd6b841e1a1db4/peplink_api_client-1.0.2.tar.gz",
"platform": null,
"description": "# peplink-api-client\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.1\n- Package version: 1.0.0\n- Generator version: 7.8.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport peplink_api_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport peplink_api_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport peplink_api_client\nfrom peplink_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = peplink_api_client.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith peplink_api_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = peplink_api_client.DefaultApi(api_client)\n token_request = peplink_api_client.TokenRequest() # TokenRequest | (optional)\n\n try:\n # Generate a new access token\n api_response = api_instance.api_auth_token_grant_post(token_request=token_request)\n print(\"The response of DefaultApi->api_auth_token_grant_post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->api_auth_token_grant_post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**api_auth_token_grant_post**](docs/DefaultApi.md#api_auth_token_grant_post) | **POST** /api/auth.token.grant | Generate a new access token\n*DefaultApi* | [**api_status_wan_connection_get**](docs/DefaultApi.md#api_status_wan_connection_get) | **GET** /api/status.wan.connection | Get WAN status\n\n\n## Documentation For Models\n\n - [BWAllowanceMonitorObj](docs/BWAllowanceMonitorObj.md)\n - [BandObj](docs/BandObj.md)\n - [CarrierObj](docs/CarrierObj.md)\n - [CellTowerObj](docs/CellTowerObj.md)\n - [GobiObj](docs/GobiObj.md)\n - [MEIDObj](docs/MEIDObj.md)\n - [ModemObj](docs/ModemObj.md)\n - [MonthlyAllowanceObj](docs/MonthlyAllowanceObj.md)\n - [RATObj](docs/RATObj.md)\n - [RemoteSIMObj](docs/RemoteSIMObj.md)\n - [RoamingObj](docs/RoamingObj.md)\n - [SIMGroupObj](docs/SIMGroupObj.md)\n - [SIMObj](docs/SIMObj.md)\n - [SignalObj](docs/SignalObj.md)\n - [TokenRequest](docs/TokenRequest.md)\n - [TokenResponse](docs/TokenResponse.md)\n - [WanStatusResponse](docs/WanStatusResponse.md)\n - [WanStatusResponseResponseValue](docs/WanStatusResponseResponseValue.md)\n - [WifiObj](docs/WifiObj.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Peplink API",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" peplink api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64d21f9c4ce904fa88e3cad968b77954e846b31bf967d2c5f7bb6f288b7036ef",
"md5": "946ff349e95ef7f80cd66b44713ba02d",
"sha256": "199cd4365b790bf769923904e0fb5eabbb2668b4d098395b8145fa90d69ccfa8"
},
"downloads": -1,
"filename": "peplink_api_client-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "946ff349e95ef7f80cd66b44713ba02d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 50075,
"upload_time": "2024-09-27T06:57:36",
"upload_time_iso_8601": "2024-09-27T06:57:36.815599Z",
"url": "https://files.pythonhosted.org/packages/64/d2/1f9c4ce904fa88e3cad968b77954e846b31bf967d2c5f7bb6f288b7036ef/peplink_api_client-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5eefb6ed4852ffc4fe54db482b8f58a05b4d21eec4317d76dfdd6b841e1a1db4",
"md5": "50370bc27f311bba091ca23646dd70b4",
"sha256": "1ad4805f29e7804f2f32841af512af15fb59a6715dca0301cd96a446e31becfe"
},
"downloads": -1,
"filename": "peplink_api_client-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "50370bc27f311bba091ca23646dd70b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 25300,
"upload_time": "2024-09-27T06:57:38",
"upload_time_iso_8601": "2024-09-27T06:57:38.162295Z",
"url": "https://files.pythonhosted.org/packages/5e/ef/b6ed4852ffc4fe54db482b8f58a05b4d21eec4317d76dfdd6b841e1a1db4/peplink_api_client-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 06:57:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "peplink_api_client"
}
JSON
