# Rust API client for 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.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
- API version: 6.0.8
- Package version: 6.0.8
- Generator version: 7.21.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
## Installation
Put the package under your project folder in a directory named `foxclient` and add the following to `Cargo.toml` under `[dependencies]`:
```
foxclient = { path = "./foxclient" }
```
## Documentation for API Endpoints
All URIs are relative to *https://api.orangefox.download*
*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* | [**download_release**](docs/ReleaseApi.md#download_release) | **GET** /release/{release_id}/dl | GET /release/{release_id}/dl - Download a release binary.
*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.
*UptimeApi* | [**get_uptime**](docs/UptimeApi.md#get_uptime) | **GET** /uptime | GET /uptime - Aggregated public infrastructure status.
## 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)
- [ReleaseListResponse](docs/ReleaseListResponse.md)
- [ReleaseResponse](docs/ReleaseResponse.md)
- [ShortDeviceResponse](docs/ShortDeviceResponse.md)
- [ShortReleaseResponse](docs/ShortReleaseResponse.md)
- [TokenResponse](docs/TokenResponse.md)
- [UptimeHealth](docs/UptimeHealth.md)
- [UptimeHealthHost](docs/UptimeHealthHost.md)
- [UptimeMonitor](docs/UptimeMonitor.md)
- [UptimeMonitorGroup](docs/UptimeMonitorGroup.md)
- [UptimeMonitors](docs/UptimeMonitors.md)
- [UptimeResponse](docs/UptimeResponse.md)
To get access to the crate's generated documentation, use:
```
cargo doc --open
```
## Author
admin@orangefox.tech