# board-mate.game
boardmate_api API

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
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:
```python
import board_mate.game
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import board_mate.game
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
import board_mate.game
from board_mate.game.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://boardmate_api
# See configuration.py for a list of all supported configuration parameters.
configuration = board_mate.game.Configuration(
    host = "https://boardmate_api"
)



# Enter a context with an instance of the API client
with board_mate.game.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = board_mate.game.GameApi(api_client)
    game_id = 'game_id_example' # str | 
    move_dto = board_mate.game.MoveDto() # MoveDto | 

    try:
        # POST moves/add/{gameId}
        api_response = api_instance.add_move(game_id, move_dto)
        print("The response of GameApi->add_move:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GameApi->add_move: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://boardmate_api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GameApi* | [**add_move**](docs/GameApi.md#add_move) | **POST** /moves/add/{gameId} | POST moves/add/{gameId}
*GameApi* | [**create_party**](docs/GameApi.md#create_party) | **POST** /create | POST create
*GameApi* | [**retrieve_games**](docs/GameApi.md#retrieve_games) | **GET** /games/{id} | GET games/{id}


## Documentation For Models

 - [GameDto](docs/GameDto.md)
 - [MoveDto](docs/MoveDto.md)
 - [ResponseBodyGameDto](docs/ResponseBodyGameDto.md)
 - [ResponseBodyString](docs/ResponseBodyString.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author