# Rust API client for eclipsis-rs

Public APIs for use within whatever you want. These are ratelimited, so try to keep requests to a minimum.

Future use of the API will require an API key.

## API Keys
API keys need to be passed alongside every request. With an API key, you are also expected to adhere to the following guidelines:
  - Do not share your API key.
  - Data can be retained for a maximum of 30 days (this is to adhere with GDPR guidelines).

API keys can also be saved to the browser for convenience using the client login/logout APIs.

You can obtain an API key by asking staff in the [Eclipsis discord](https://discord.gg/AkDsUtz).



## 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: 3.0.0
- Package version: 3.0.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `eclipsis-rs` and add the following to `Cargo.toml` under `[dependencies]`:

```
eclipsis-rs = { path = "./eclipsis-rs" }
```

## Documentation for API Endpoints

All URIs are relative to *https://api.xethlyx.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ClientApi* | [**client_delete**](docs/ClientApi.md#client_delete) | **DELETE** /client/delete | Delete
*ClientApi* | [**client_info**](docs/ClientApi.md#client_info) | **GET** /client/info | Info
*ClientApi* | [**client_login**](docs/ClientApi.md#client_login) | **POST** /client/login | Login
*ClientApi* | [**client_logout**](docs/ClientApi.md#client_logout) | **POST** /client/logout | Logout
*MatchApi* | [**get_match**](docs/MatchApi.md#get_match) | **GET** /eclipsis/match/{matchId} | Get match data
*UserApi* | [**get_user_delta**](docs/UserApi.md#get_user_delta) | **GET** /eclipsis/user/delta/{userId} | Get rating delta
*UserApi* | [**get_user_matches**](docs/UserApi.md#get_user_matches) | **GET** /eclipsis/user/matches/{userId} | Get matches
*UserApi* | [**get_user_overview**](docs/UserApi.md#get_user_overview) | **GET** /eclipsis/user/overview/{userId} | Get overview
*UserApi* | [**get_user_playtime**](docs/UserApi.md#get_user_playtime) | **GET** /eclipsis/user/playtime/{userId} | Get playtime
*UserApi* | [**get_user_rating**](docs/UserApi.md#get_user_rating) | **GET** /eclipsis/user/rating/{userId} | Get rating
*UserApi* | [**get_user_status**](docs/UserApi.md#get_user_status) | **POST** /eclipsis/user/status | Get basic status
*UserApi* | [**get_user_teammates**](docs/UserApi.md#get_user_teammates) | **GET** /eclipsis/user/teammates/{userId} | Get teammates


## Documentation For Models

 - [ApiError](docs/ApiError.md)
 - [ApiKeyData](docs/ApiKeyData.md)
 - [Match](docs/Match.md)
 - [MatchPlayer](docs/MatchPlayer.md)
 - [MatchTeam](docs/MatchTeam.md)
 - [Success](docs/Success.md)
 - [Success1](docs/Success1.md)
 - [Success10](docs/Success10.md)
 - [Success10ValueInnerInner](docs/Success10ValueInnerInner.md)
 - [Success11](docs/Success11.md)
 - [Success2](docs/Success2.md)
 - [Success3](docs/Success3.md)
 - [Success4](docs/Success4.md)
 - [Success5](docs/Success5.md)
 - [Success6](docs/Success6.md)
 - [Success7](docs/Success7.md)
 - [Success7ValueInnerInnerInner](docs/Success7ValueInnerInnerInner.md)
 - [Success8](docs/Success8.md)
 - [Success9](docs/Success9.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author