# 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: 5.2.8
- Package version: 5.2.8
- Generator version: 7.13.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 Device
*DeviceApi* | [**get_device_deprecated**](docs/DeviceApi.md#get_device_deprecated) | **GET** /devices/{device_id} | Get Device Short
*DeviceApi* | [**get_devices**](docs/DeviceApi.md#get_devices) | **GET** /devices/ | Get Devices
*DeviceApi* | [**get_oems**](docs/DeviceApi.md#get_oems) | **GET** /oems/ | Get Oems
*PasteApi* | [**create_paste_paste_post**](docs/PasteApi.md#create_paste_paste_post) | **POST** /paste/ | Create Paste
*PasteApi* | [**get_paste_paste_paste_id_get**](docs/PasteApi.md#get_paste_paste_paste_id_get) | **GET** /paste/{paste_id} | Get Paste
*ReleaseApi* | [**get_release**](docs/ReleaseApi.md#get_release) | **GET** /releases/get | Get Release
*ReleaseApi* | [**get_release_deprecated**](docs/ReleaseApi.md#get_release_deprecated) | **GET** /releases/{release_id} | Get Release Short
*ReleaseApi* | [**get_releases**](docs/ReleaseApi.md#get_releases) | **GET** /releases/ | Get Releases
*ReleaseApi* | [**get_updates_deprecated**](docs/ReleaseApi.md#get_updates_deprecated) | **GET** /updates/{last_known_id} | Get Updates
*StatsApi* | [**get_public_stats**](docs/StatsApi.md#get_public_stats) | **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)
- [PasteInput](docs/PasteInput.md)
- [PasteOutput](docs/PasteOutput.md)
- [RecoveryImgResponse](docs/RecoveryImgResponse.md)
- [ReleaseGroupsResponse](docs/ReleaseGroupsResponse.md)
- [ReleaseResponse](docs/ReleaseResponse.md)
- [ReleaseType](docs/ReleaseType.md)
- [ReleasesSort](docs/ReleasesSort.md)
- [ResponseGetReleases](docs/ResponseGetReleases.md)
- [ShortDeviceResponse](docs/ShortDeviceResponse.md)
- [ShortReleaseResponse](docs/ShortReleaseResponse.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
To get access to the crate's generated documentation, use:
```
cargo doc --open
```
## Author
admin@orangefox.tech