foxclient 1.0.0__tar.gz

foxclient-1.0.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: foxclient
+Version: 1.0.0
+Summary: Fox API
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: admin@orangefox.tech
+Keywords: OpenAPI,OpenAPI-Generator,Fox API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+     Warning: Please add a custom &#39;X-FoxAPI-App&#x3D;MyAppName&#39; header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application&#39;s access to the API. In future, this may be a mandatory requirement.  To reduce the system load, the API endpoints are rate limited. The default limit is 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit.  The requests may be logged for analytics and development purposes. 
+    

foxclient-1.0.0/README.md

@@ -0,0 +1,164 @@
+# foxclient
+
+Warning: Please add a custom 'X-FoxAPI-App=MyAppName' header to your requests.
+This would help us fighting against DDoS attacks in future, while keeping your application's access to the API.
+In future, this may be a mandatory requirement.
+
+To reduce the system load, the API endpoints are rate limited.
+The default limit is 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit.
+
+The requests may be logged for analytics and development purposes.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 5.1.1
+- Package version: 1.0.0
+- Generator version: 7.13.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.9+
+
+## 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 foxclient
+```
+
+### 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 foxclient
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import foxclient
+from foxclient.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 = foxclient.Configuration(
+    host = "http://localhost"
+)
+
+# 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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Configure Bearer authorization (JWT): bearer_auth
+configuration = foxclient.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with foxclient.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = foxclient.DeviceApi(api_client)
+    device_id = 'device_id_example' # str | 
+
+    try:
+        # Get Device
+        api_response = api_instance.get_device_devices_device_id_get(device_id)
+        print("The response of DeviceApi->get_device_devices_device_id_get:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling DeviceApi->get_device_devices_device_id_get: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DeviceApi* | [**get_device_devices_device_id_get**](docs/DeviceApi.md#get_device_devices_device_id_get) | **GET** /devices/{device_id} | Get Device
+*DeviceApi* | [**get_device_extended_devices_get_get**](docs/DeviceApi.md#get_device_extended_devices_get_get) | **GET** /devices/get | Get Device Extended
+*DeviceApi* | [**get_devices_list_devices_get**](docs/DeviceApi.md#get_devices_list_devices_get) | **GET** /devices/ | Get Devices List
+*DeviceApi* | [**get_oems_list_oems_get**](docs/DeviceApi.md#get_oems_list_oems_get) | **GET** /oems/ | Get Oems List
+*ReleaseApi* | [**get_release_extended_releases_get_get**](docs/ReleaseApi.md#get_release_extended_releases_get_get) | **GET** /releases/get | Get Release Extended
+*ReleaseApi* | [**get_release_releases_release_id_get**](docs/ReleaseApi.md#get_release_releases_release_id_get) | **GET** /releases/{release_id} | Get Release
+*ReleaseApi* | [**get_releases_releases_get**](docs/ReleaseApi.md#get_releases_releases_get) | **GET** /releases/ | Get Releases
+*ReleaseApi* | [**get_updates_updates_last_known_id_get**](docs/ReleaseApi.md#get_updates_updates_last_known_id_get) | **GET** /updates/{last_known_id} | Get Updates
+*StatsApi* | [**public_stats_stats_get**](docs/StatsApi.md#public_stats_stats_get) | **GET** /stats/ | Public Stats
+
+
+## Documentation For Models
+
+ - [DeviceResponse](docs/DeviceResponse.md)
+ - [GlobalStatsAggregationModel](docs/GlobalStatsAggregationModel.md)
+ - [HTTPValidationError](docs/HTTPValidationError.md)
+ - [ListResponseReleaseResponse](docs/ListResponseReleaseResponse.md)
+ - [ListResponseShortDeviceResponse](docs/ListResponseShortDeviceResponse.md)
+ - [ListResponseShortReleaseResponse](docs/ListResponseShortReleaseResponse.md)
+ - [ListResponseStr](docs/ListResponseStr.md)
+ - [MaintainerShortModel](docs/MaintainerShortModel.md)
+ - [RecoveryImgResponse](docs/RecoveryImgResponse.md)
+ - [ReleaseGroupsResponse](docs/ReleaseGroupsResponse.md)
+ - [ReleaseResponse](docs/ReleaseResponse.md)
+ - [ReleaseType](docs/ReleaseType.md)
+ - [ReleasesSort](docs/ReleasesSort.md)
+ - [ResponseGetReleasesReleasesGet](docs/ResponseGetReleasesReleasesGet.md)
+ - [ShortDeviceResponse](docs/ShortDeviceResponse.md)
+ - [ShortReleaseResponse](docs/ShortReleaseResponse.md)
+ - [ValidationError](docs/ValidationError.md)
+ - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearer_auth"></a>
+### bearer_auth
+
+- **Type**: Bearer authentication (JWT)
+
+<a id="oauth2_password"></a>
+### oauth2_password
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+
+
+## Author
+
+admin@orangefox.tech
+
+

foxclient-1.0.0/foxclient/__init__.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Fox API
+
+     Warning: Please add a custom 'X-FoxAPI-App=MyAppName' header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application's access to the API. In future, this may be a mandatory requirement.  To reduce the system load, the API endpoints are rate limited. The default limit is 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit.  The requests may be logged for analytics and development purposes. 
+
+    The version of the OpenAPI document: 5.1.1
+    Contact: admin@orangefox.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+from foxclient.api.device_api import DeviceApi
+from foxclient.api.release_api import ReleaseApi
+from foxclient.api.stats_api import StatsApi
+
+# import ApiClient
+from foxclient.api_response import ApiResponse
+from foxclient.api_client import ApiClient
+from foxclient.configuration import Configuration
+from foxclient.exceptions import OpenApiException
+from foxclient.exceptions import ApiTypeError
+from foxclient.exceptions import ApiValueError
+from foxclient.exceptions import ApiKeyError
+from foxclient.exceptions import ApiAttributeError
+from foxclient.exceptions import ApiException
+
+# import models into sdk package
+from foxclient.models.device_response import DeviceResponse
+from foxclient.models.global_stats_aggregation_model import GlobalStatsAggregationModel
+from foxclient.models.http_validation_error import HTTPValidationError
+from foxclient.models.list_response_release_response import ListResponseReleaseResponse
+from foxclient.models.list_response_short_device_response import ListResponseShortDeviceResponse
+from foxclient.models.list_response_short_release_response import ListResponseShortReleaseResponse
+from foxclient.models.list_response_str import ListResponseStr
+from foxclient.models.maintainer_short_model import MaintainerShortModel
+from foxclient.models.recovery_img_response import RecoveryImgResponse
+from foxclient.models.release_groups_response import ReleaseGroupsResponse
+from foxclient.models.release_response import ReleaseResponse
+from foxclient.models.release_type import ReleaseType
+from foxclient.models.releases_sort import ReleasesSort
+from foxclient.models.response_get_releases_releases_get import ResponseGetReleasesReleasesGet
+from foxclient.models.short_device_response import ShortDeviceResponse
+from foxclient.models.short_release_response import ShortReleaseResponse
+from foxclient.models.validation_error import ValidationError
+from foxclient.models.validation_error_loc_inner import ValidationErrorLocInner

foxclient-1.0.0/foxclient/api/__init__.py

@@ -0,0 +1,7 @@
+# flake8: noqa
+
+# import apis into api package
+from foxclient.api.device_api import DeviceApi
+from foxclient.api.release_api import ReleaseApi
+from foxclient.api.stats_api import StatsApi
+