foxinternalclient 6.0.5

Fox API

foxinternalclient

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.5
• Package version: 6.0.5
• 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 foxinternalclient

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 foxinternalclient

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import foxinternalclient
from foxinternalclient.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 = foxinternalclient.Configuration(
    host = "https://api.orangefox.download"
)



# Enter a context with an instance of the API client
async with foxinternalclient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = foxinternalclient.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.
FoxFactoryApi	cancel_task	POST /factory/{task_id}/cancel	POST /internal/factory/{task_id}/cancel – Cancel a running build task.
FoxFactoryApi	create_task	POST /factory	POST /internal/factory – Create a new build task.
FoxFactoryApi	delete_task	DELETE /factory/{task_id}	DELETE /internal/factory/{task_id} – Delete a build task and its artifact.
FoxFactoryApi	download_artifact	GET /factory/{task_id}/artifact	GET /internal/factory/{task_id}/artifact – Download a build artifact.
FoxFactoryApi	get_factory_status	GET /factory/status	GET /internal/factory/status – Get the current FoxFactory worker status.
FoxFactoryApi	get_task	GET /factory/{task_id}	GET /internal/factory/{task_id} – Get a single build task.
FoxFactoryApi	list_tasks	GET /factory	GET /internal/factory – List build tasks.
FoxFactoryApi	update_task	PATCH /factory/{task_id}	PATCH /internal/factory/{task_id} – Update task status / logs.
FoxFactoryApi	update_worker_status	POST /factory/update_status	POST /internal/factory/update_status – Worker heartbeat / status update.
FoxFactoryApi	upload_artifact	POST /factory/{task_id}/artifact	POST /internal/factory/{task_id}/artifact – Upload a build artifact.
GitlabApi	add_gitlab_repo	POST /gitlab/device/{device_id}/gitlab	POST /gitlab/device/{device_id}/gitlab?gl_project_url=<url>
InternalApi	change_password	POST /profile/change_password	POST /profile/change_password - Change the authenticated user's password.
InternalApi	create_device	POST /internal/devices	POST /internal/devices/ - Create a new device.
InternalApi	delete_device	DELETE /internal/devices/{device_id}	DELETE /internal/devices/{device_id} - Delete a device (only if no releases exist).
InternalApi	delete_passkey	DELETE /profile/passkeys/{credential_id}	DELETE /profile/passkeys/{credential_id} - Revoke a passkey credential (requires password).
InternalApi	delete_paste	DELETE /internal/paste/{paste_id}	DELETE /internal/paste/{paste_id} - Delete a paste (admin only).
InternalApi	delete_release	DELETE /internal/releases/{release_id}	DELETE /internal/releases/{release_id} - Delete a release.
InternalApi	delete_user	DELETE /internal/users/{user_id}	DELETE /internal/users/{user_id} - Delete a user.
InternalApi	edit_device	PUT /internal/devices/{device_id}	PUT /internal/devices/{device_id} - Update a device.
InternalApi	edit_release	PUT /internal/releases/{release_id}	PUT /internal/releases/{release_id} - Edit a release.
InternalApi	edit_user	PUT /internal/users/{user_id}	PUT /internal/users/{user_id} - Update a user (admin only).
InternalApi	get_device_info	GET /internal/devices/{device_id}	GET /internal/devices/{device_id} - Get device with stats.
InternalApi	get_release_info	GET /internal/releases/{release_id}	GET /internal/releases/{release_id} - Get release with stats and maintainer info.
InternalApi	get_user	GET /internal/users/{user_id}	GET /internal/users/{user_id} - Get user with maintained devices.
InternalApi	list_logs	GET /internal/logs	GET /internal/logs/ - Get paginated audit logs.
InternalApi	list_passkeys	GET /profile/passkeys	GET /profile/passkeys - List the authenticated user's passkey credentials.
InternalApi	list_pastes	GET /internal/paste	GET /internal/paste/ - List all pastes (admin only).
InternalApi	list_users	GET /internal/users	GET /internal/users/ - List all users (short response).
InternalApi	login	POST /auth/login	POST /auth/login
InternalApi	logout	POST /auth/logout	POST /auth/logout
InternalApi	passkey_login_options	POST /auth/passkeys/login/options	POST /auth/passkeys/login/options
InternalApi	passkey_login_verify	POST /auth/passkeys/login/verify	POST /auth/passkeys/login/verify
InternalApi	passkey_register_options	POST /auth/passkeys/register/options	POST /auth/passkeys/register/options
InternalApi	passkey_register_verify	POST /auth/passkeys/register/verify	POST /auth/passkeys/register/verify
InternalApi	rename_passkey	POST /profile/passkeys/{credential_id}/rename	POST /profile/passkeys/{credential_id}/rename - Rename a passkey credential.
InternalApi	renew	POST /auth/renew	POST /auth/renew
InternalApi	update_paste	PUT /internal/paste/{paste_id}	PUT /internal/paste/{paste_id} - Update paste content (admin only).
InternalApi	upload_new_release	POST /internal/releases	POST /internal/releases/ - Upload a new release.
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.
UsbApi	create_session	POST /internal/usb/sessions	POST /internal/usb/sessions - Create a remote USB bridge session.
UsbApi	delete_session	DELETE /internal/usb/sessions/{code}	DELETE /internal/usb/sessions/{code} - Revoke a session.
UsbApi	list_sessions	GET /internal/usb/sessions	GET /internal/usb/sessions - List the caller's active sessions.

Documentation For Models

• BuildTaskResponse
• BuildTaskShortResponse
• ChangePasswordBody
• CreateUsbSessionBody
• DeletePasskeyBody
• DeviceInternalResponse
• DeviceResponse
• DeviceStatsResponse
• DeviceUpdateBody
• ErrorResponse
• FFStatusResponse
• GlobalStatsResponse
• ListResponseBuildTaskShortResponse
• ListResponseBuildTaskShortResponseDataInner
• ListResponsePasteResponse
• ListResponsePasteResponseDataInner
• ListResponseReleaseResponse
• ListResponseReleaseResponseDataInner
• ListResponseShortDeviceResponse
• ListResponseShortDeviceResponseDataInner
• ListResponseString
• ListResponseUserShortResponse
• ListResponseUserShortResponseDataInner
• LogListResponse
• LogResponse
• LoginForm
• MaintainerShortResponse
• NewBuildTaskBody
• NewDeviceBody
• NewReportRequest
• PasskeyCredentialResponse
• PasskeyRegisterOptionsRequest
• PasskeyVerifyRequest
• PasteInput
• PasteResponse
• RecoveryImgResponse
• ReleaseGroupsResponse
• ReleaseInternalResponse
• ReleaseResponse
• ReleaseStatsResponse
• ReleaseUpdateBody
• RenamePasskeyBody
• ShortDeviceResponse
• ShortReleaseResponse
• TaskUpdateBody
• TokenResponse
• UsbSessionListResponse
• UsbSessionResponse
• UserInternalResponse
• UserShortResponse
• UserUpdateBody
• WorkerStatusBody

Documentation For Authorization

Authentication schemes defined for the API:

bearer_auth

• Type: Bearer authentication (JWT)

Author

[e-mail]