gamenight/gamenight-api-client-rs/docs/DefaultApi.md

\DefaultApi

All URIs are relative to http://localhost:8080

Method	HTTP request	Description
delete_game	DELETE /game/{gameId}	Delete this game.
delete_game_owner	DELETE /game/{gameId}/owner/{userId}	no longer own this game
delete_gamenight_participant	DELETE /gamenight/{gamenightId}/participant/{userId}	deletes a gamenight participant
delete_location_authorized_user	DELETE /location/{locationId}/authorized_user/{userId}	remove an authorized user from a location
get_game	GET /game/{gameId}	Get this specific game
get_gamenight	GET /gamenight/{gamenightId}	get the specified gamenight
get_gamenight_participants	GET /gamenight/{gamenightId}/participants	Get all participants for a gamenight
get_gamenights	GET /gamenights	Get a all gamenights
get_games	GET /games	get all games
get_location	GET /location/{locationId}	gets this location
get_location_authorized_users	GET /location/{locationId}/authorized_users/	gets this locations authorized users
get_locations	GET /locations	get all locations
get_user	GET /user/{userId}
get_user_owned_games	GET /user/{userId}/owned_games	Get owned games of user
get_users	GET /users	Get all users
post_game_owners	POST /game/{gameId}/owners	Own this game
post_gamenight_participants	POST /gamenight/{gamenightId}/participants	Add a participant
post_gamenights	POST /gamenights	Gets the gamenight
post_games	POST /games	add a game
post_location_authorized_users	POST /location/{locationId}/authorized_users/	Authorize a user
post_locations	POST /locations	add a location
post_refresh_token	POST /refresh_token	Refresh a user token
post_token	POST /token	Login a user.
post_users	POST /users	Registers a user into gamenight.
put_game	PUT /game/{gameId}	Changes this game resource

delete_game

delete_game(game_id) Delete this game.

Parameters

Name	Type	Description	Required	Notes
game_id	String	Uuid of game to delete.	[required]

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_game_owner

delete_game_owner(game_id, user_id) no longer own this game

Parameters

Name	Type	Description	Required	Notes
game_id	String	Uuid of game that user no longer owns.	[required]
user_id	String	Uuid of user that no longer owns.	[required]

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_gamenight_participant

delete_gamenight_participant(gamenight_id, user_id) deletes a gamenight participant

Parameters

Name	Type	Description	Required	Notes
gamenight_id	String	Uuid of gamenight to delete participant for	[required]
user_id	String	Uuid of the of the participant to remove	[required]

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_location_authorized_user

delete_location_authorized_user(location_id, user_id) remove an authorized user from a location

Parameters

Name	Type	Description	Required	Notes
location_id	String	Uuid of location to deauthorize for.	[required]
user_id	String	Uuid of user ot deauthorize.	[required]

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_game

models::Game get_game(game_id) Get this specific game

Parameters

Name	Type	Description	Required	Notes
game_id	String	Uuid of game to get.	[required]

Return type

models::Game

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_gamenight

models::Gamenight get_gamenight(gamenight_id) get the specified gamenight

Parameters

Name	Type	Description	Required	Notes
gamenight_id	String	Uuid of gamenight to get.	[required]

Return type

models::Gamenight

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_gamenight_participants

models::Participants get_gamenight_participants(gamenight_id) Get all participants for a gamenight

Retrieve the participants of a single gamenight by id.

Parameters

Name	Type	Description	Required	Notes
gamenight_id	String	Uuid of gamenight to get participants for.	[required]

Return type

models::Participants

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_gamenights

Vecmodels::Gamenight get_gamenights() Get a all gamenights

Retrieve the list of gamenights on this gamenight server. Requires authorization.

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::Gamenight

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_games

Vecmodels::Game get_games() get all games

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::Game

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_location

models::Location get_location(location_id) gets this location

Parameters

Name	Type	Description	Required	Notes
location_id	String	Uuid of location to get.	[required]

Return type

models::Location

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_location_authorized_users

Vecmodels::UserId get_location_authorized_users(location_id) gets this locations authorized users

Parameters

Name	Type	Description	Required	Notes
location_id	String	Uuid of location to get authorized users for.	[required]

Return type

Vecmodels::UserId

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_locations

Vecmodels::Location get_locations() get all locations

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::Location

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user

models::User get_user(user_id)

Get a user from primary id

Parameters

Name	Type	Description	Required	Notes
user_id	String	Uuid of user to get	[required]

Return type

models::User

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_owned_games

Vecmodels::OwnedGame get_user_owned_games(user_id) Get owned games of user

Parameters

Name	Type	Description	Required	Notes
user_id	String	Uuid of user to get owned games for.	[required]

Return type

Vecmodels::OwnedGame

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users

Vecmodels::User get_users() Get all users

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::User

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_game_owners

post_game_owners(game_id, own_game) Own this game

Parameters

Name	Type	Description	Required	Notes
game_id	String	Uuid of game to own.	[required]
own_game	Option<OwnGame>

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_gamenight_participants

post_gamenight_participants(gamenight_id, user_id) Add a participant

Parameters

Name	Type	Description	Required	Notes
gamenight_id	String	Uuid of gamenight to add participants for.	[required]
user_id	Option<UserId>

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_gamenights

post_gamenights(add_gamenight_request_body) Gets the gamenight

Add a gamenight by providing a name and a date, only available when providing an JWT token.

Parameters

Name	Type	Description	Required	Notes
add_gamenight_request_body	Option<AddGamenightRequestBody>

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_games

models::GameId post_games(add_game_request_body) add a game

Parameters

Name	Type	Description	Required	Notes
add_game_request_body	Option<AddGameRequestBody>

Return type

models::GameId

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_location_authorized_users

post_location_authorized_users(location_id, user_id) Authorize a user

Parameters

Name	Type	Description	Required	Notes
location_id	String	Uuid location to authorize for.	[required]
user_id	Option<UserId>

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_locations

models::LocationId post_locations(add_location_request_body) add a location

Parameters

Name	Type	Description	Required	Notes
add_location_request_body	Option<AddLocationRequestBody>

Return type

models::LocationId

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_refresh_token

models::Token post_refresh_token() Refresh a user token

Refresh your JWT-token without logging in again.

Parameters

This endpoint does not need any parameter.

Return type

models::Token

Authorization

JWT-Auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_token

models::Token post_token(login) Login a user.

Submit your credentials to get a JWT-token to use with the rest of the api.

Parameters

Name	Type	Description	Required	Notes
login	Option<Login>

Return type

models::Token

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_users

post_users(registration) Registers a user into gamenight.

Create a new user given a registration token and user information, username and email must be unique, and password and password_repeat must match.

Parameters

Name	Type	Description	Required	Notes
registration	Option<Registration>

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_game

put_game(game_id, edit_game_request_body) Changes this game resource

Parameters

Name	Type	Description	Required	Notes
game_id	String	Uuid of game to change.	[required]
edit_game_request_body	Option<EditGameRequestBody>

Return type

(empty response body)

Authorization

JWT-Auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]