# Rust API client for puddle-farm-api-client_openapi_client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
## 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: v1
- Package version: 1.0.0
- Generator version: 7.14.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
## Installation
Put the package under your project folder in a directory named `puddle-farm-api-client_openapi_client` and add the following to `Cargo.toml` under `[dependencies]`:
```
puddle-farm-api-client_openapi_client = { path = "./puddle-farm-api-client_openapi_client" }
```
## Documentation for API Endpoints
All URIs are relative to *https://puddle.farm/api*
*DefaultApi* | [**alias_player_id_get**](docs/DefaultApi.md#alias_player_id_get) | **GET** /alias/{player_id} | Get player's aliases
*DefaultApi* | [**avatar_player_id_get**](docs/DefaultApi.md#avatar_player_id_get) | **GET** /avatar/{player_id} | Get player's avatar image
*DefaultApi* | [**calc_rating_get**](docs/DefaultApi.md#calc_rating_get) | **GET** /calc_rating | Calculate rating changes for a match
*DefaultApi* | [**characters_get**](docs/DefaultApi.md#characters_get) | **GET** /characters | Get a list of all characters
*DefaultApi* | [**claim_player_id_get**](docs/DefaultApi.md#claim_player_id_get) | **GET** /claim/{player_id} | Initiate a claim for a player's profile
*DefaultApi* | [**claim_poll_player_id_get**](docs/DefaultApi.md#claim_poll_player_id_get) | **GET** /claim/poll/{player_id} | Poll for the status of a player's profile claim
*DefaultApi* | [**distribution_get**](docs/DefaultApi.md#distribution_get) | **GET** /distribution | Get player rating distribution data
*DefaultApi* | [**health_get**](docs/DefaultApi.md#health_get) | **GET** /health | Get health status of the system
*DefaultApi* | [**matchups_get**](docs/DefaultApi.md#matchups_get) | **GET** /matchups | Get character matchup data
*DefaultApi* | [**matchups_player_id_char_id_duration_get**](docs/DefaultApi.md#matchups_player_id_char_id_duration_get) | **GET** /matchups/{player_id}/{char_id}/{duration} | Get player's character matchup data
*DefaultApi* | [**player_id_get**](docs/DefaultApi.md#player_id_get) | **GET** /player/{id} | Get player by ID
*DefaultApi* | [**player_player_id_char_id_history_get**](docs/DefaultApi.md#player_player_id_char_id_history_get) | **GET** /player/{player_id}/{char_id}/history | Get player's match history for a specific character
*DefaultApi* | [**player_search_get**](docs/DefaultApi.md#player_search_get) | **GET** /player/search | Search for players by name
*DefaultApi* | [**popularity_get**](docs/DefaultApi.md#popularity_get) | **GET** /popularity | Get character popularity data
*DefaultApi* | [**ratings_player_id_char_id_duration_get**](docs/DefaultApi.md#ratings_player_id_char_id_duration_get) | **GET** /ratings/{player_id}/{char_id}/{duration} | Get player's rating history for a specific character
*DefaultApi* | [**settings_key_get**](docs/DefaultApi.md#settings_key_get) | **GET** /settings/{key} | Get player's settings
*DefaultApi* | [**stats_get**](docs/DefaultApi.md#stats_get) | **GET** /stats | Get global statistics
*DefaultApi* | [**supporters_get**](docs/DefaultApi.md#supporters_get) | **GET** /supporters | Get list of supporters
*DefaultApi* | [**toggle_private_key_get**](docs/DefaultApi.md#toggle_private_key_get) | **GET** /toggle_private/{key} | Toggle player's privacy setting
*DefaultApi* | [**top_char_char_id_get**](docs/DefaultApi.md#top_char_char_id_get) | **GET** /top_char/{char_id} | Get top ranked players for a specific character
*DefaultApi* | [**top_get**](docs/DefaultApi.md#top_get) | **GET** /top | Get top ranked players
## Documentation For Models
- [CalcRatingResponse](docs/CalcRatingResponse.md)
- [DistributionEntry](docs/DistributionEntry.md)
- [DistributionResponse](docs/DistributionResponse.md)
- [MatchupCharResponse](docs/MatchupCharResponse.md)
- [MatchupEntry](docs/MatchupEntry.md)
- [MatchupResponse](docs/MatchupResponse.md)
- [PlayerGamesResponse](docs/PlayerGamesResponse.md)
- [PlayerRankResponse](docs/PlayerRankResponse.md)
- [PlayerResponse](docs/PlayerResponse.md)
- [PlayerResponsePlayer](docs/PlayerResponsePlayer.md)
- [PlayerSearchResponse](docs/PlayerSearchResponse.md)
- [PlayerSet](docs/PlayerSet.md)
- [PopularityResult](docs/PopularityResult.md)
- [PopularityResultChar](docs/PopularityResultChar.md)
- [RankResponse](docs/RankResponse.md)
- [RatingsResponse](docs/RatingsResponse.md)
- [SearchResponse](docs/SearchResponse.md)
- [SettingsResponse](docs/SettingsResponse.md)
- [StatsResponse](docs/StatsResponse.md)
- [Supporter](docs/Supporter.md)
- [TagResponse](docs/TagResponse.md)
- [TopDefeated](docs/TopDefeated.md)
- [TopRating](docs/TopRating.md)
To get access to the crate's generated documentation, use:
```
cargo doc --open
```
## Author