foxclient 6.0.1

Fox API

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 [e-mail] 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 project:

• API version: 6.0.1
• Package version: 6.0.1
• 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:

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:

import foxclient

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import foxclient

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	GET /devices/get	GET /devices/get - Get a single device by device_id, codename, or _id.
DeviceApi	get_device_by_id	GET /devices/{device_id}	GET /devices/{device_id} - Get device by ID (deprecated).
DeviceApi	get_oems	GET /oems	GET /oems - Get a list of all unique OEM names.
DeviceApi	list_devices	GET /devices	GET /devices/ - List devices with filters.
PasteApi	create_paste	POST /paste	POST /paste/ - Create a new paste.
PasteApi	get_paste	GET /paste/{paste_id}	GET /paste/{paste_id} - Get a paste by ID.
ReleaseApi	download_release	GET /release/{release_id}/dl	GET /release/{release_id}/dl - Download a release binary.
ReleaseApi	get_release	GET /releases/get	GET /releases/get - Get a single release.
ReleaseApi	get_release_by_id	GET /releases/{release_id}	GET /releases/{release_id} - Get release by ID (deprecated).
ReleaseApi	get_updates_after	GET /updates/{last_known_id}	GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
ReleaseApi	list_releases	GET /releases	GET /releases/ - List releases with filters.
ReportApi	new_report	POST /report/{release_id}	POST /report/{release_id} - Submit a bug report.
StatsApi	get_global_stats	GET /stats	GET /stats/ - Get global download statistics.

Documentation For Models

• DeviceResponse
• ErrorResponse
• GlobalStatsResponse
• ListResponseReleaseResponse
• ListResponseReleaseResponseDataInner
• ListResponseShortDeviceResponse
• ListResponseShortDeviceResponseDataInner
• ListResponseString
• MaintainerShortResponse
• NewReportRequest
• PasteInput
• PasteResponse
• RecoveryImgResponse
• ReleaseGroupsResponse
• ReleaseResponse
• ShortDeviceResponse
• ShortReleaseResponse
• TokenResponse

Documentation For Authorization

Authentication schemes defined for the API:

bearer_auth

• Type: Bearer authentication (JWT)

Author

[e-mail]