Metadata-Version: 2.4
Name: foxclient
Version: 6.0.0
Summary: Fox API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <admin@orangefox.tech>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Fox API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: aiohttp>=3.8.4
Requires-Dist: aiohttp-retry>=2.8.3
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# foxclient
Warning: Please add a custom user agent 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 30 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: 6.0.0
- Package version: 6.0.0
- Generator version: 7.21.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 https://api.orangefox.download
# See configuration.py for a list of all supported configuration parameters.
configuration = foxclient.Configuration(
    host = "https://api.orangefox.download"
)



# Enter a context with an instance of the API client
async 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 |  (optional)
    codename = 'codename_example' # str |  (optional)
    id = 'id_example' # str |  (optional)

    try:
        # GET /devices/get - Get a single device by device_id, codename, or _id.
        api_response = await api_instance.get_device(device_id=device_id, codename=codename, id=id)
        print("The response of DeviceApi->get_device:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DeviceApi->get_device: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.orangefox.download*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DeviceApi* | [**get_device**](docs/DeviceApi.md#get_device) | **GET** /devices/get | GET /devices/get - Get a single device by device_id, codename, or _id.
*DeviceApi* | [**get_device_by_id**](docs/DeviceApi.md#get_device_by_id) | **GET** /devices/{device_id} | GET /devices/{device_id} - Get device by ID (deprecated).
*DeviceApi* | [**get_oems**](docs/DeviceApi.md#get_oems) | **GET** /oems | GET /oems - Get a list of all unique OEM names.
*DeviceApi* | [**list_devices**](docs/DeviceApi.md#list_devices) | **GET** /devices | GET /devices/ - List devices with filters.
*PasteApi* | [**create_paste**](docs/PasteApi.md#create_paste) | **POST** /paste | POST /paste/ - Create a new paste.
*PasteApi* | [**get_paste**](docs/PasteApi.md#get_paste) | **GET** /paste/{paste_id} | GET /paste/{paste_id} - Get a paste by ID.
*ReleaseApi* | [**get_release**](docs/ReleaseApi.md#get_release) | **GET** /releases/get | GET /releases/get - Get a single release.
*ReleaseApi* | [**get_release_by_id**](docs/ReleaseApi.md#get_release_by_id) | **GET** /releases/{release_id} | GET /releases/{release_id} - Get release by ID (deprecated).
*ReleaseApi* | [**get_updates_after**](docs/ReleaseApi.md#get_updates_after) | **GET** /updates/{last_known_id} | GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
*ReleaseApi* | [**list_releases**](docs/ReleaseApi.md#list_releases) | **GET** /releases | GET /releases/ - List releases with filters.
*ReportApi* | [**new_report**](docs/ReportApi.md#new_report) | **POST** /report/{release_id} | POST /report/{release_id} - Submit a bug report.
*StatsApi* | [**get_global_stats**](docs/StatsApi.md#get_global_stats) | **GET** /stats | GET /stats/ - Get global download statistics.


## Documentation For Models

 - [DeviceResponse](docs/DeviceResponse.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [GlobalStatsResponse](docs/GlobalStatsResponse.md)
 - [ListResponseReleaseResponse](docs/ListResponseReleaseResponse.md)
 - [ListResponseReleaseResponseDataInner](docs/ListResponseReleaseResponseDataInner.md)
 - [ListResponseShortDeviceResponse](docs/ListResponseShortDeviceResponse.md)
 - [ListResponseShortDeviceResponseDataInner](docs/ListResponseShortDeviceResponseDataInner.md)
 - [ListResponseString](docs/ListResponseString.md)
 - [MaintainerShortResponse](docs/MaintainerShortResponse.md)
 - [NewReportRequest](docs/NewReportRequest.md)
 - [PasteInput](docs/PasteInput.md)
 - [PasteResponse](docs/PasteResponse.md)
 - [RecoveryImgResponse](docs/RecoveryImgResponse.md)
 - [ReleaseGroupsResponse](docs/ReleaseGroupsResponse.md)
 - [ReleaseResponse](docs/ReleaseResponse.md)
 - [ShortDeviceResponse](docs/ShortDeviceResponse.md)
 - [ShortReleaseResponse](docs/ShortReleaseResponse.md)
 - [TokenResponse](docs/TokenResponse.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)


## Author

admin@orangefox.tech


