@tennac-booking/sdk
Version:
OpenAPI client for @tennac-booking/sdk
230 lines (150 loc) • 5.53 kB
Markdown
# SportsApi
All URIs are relative to *https://api.mon-domaine.com*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createSport**](#createsport) | **POST** /api/sports | Crée un sport dans un club|
|[**deleteSport**](#deletesport) | **DELETE** /api/sports/{id} | Supprime un sport|
|[**getAllSports**](#getallsports) | **GET** /api/sports | Récupère la liste des sports d’un club|
|[**updateSport**](#updatesport) | **PUT** /api/sports/{id} | Met à jour un sport|
# **createSport**
> Sport createSport(createSportRequest)
### Example
```typescript
import {
SportsApi,
Configuration,
CreateSportRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new SportsApi(configuration);
let createSportRequest: CreateSportRequest; //
const { status, data } = await apiInstance.createSport(
createSportRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **createSportRequest** | **CreateSportRequest**| | |
### Return type
**Sport**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Sport créé | - |
|**400** | Requête invalide | - |
|**401** | Non autorisé | - |
|**500** | Erreur serveur interne | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **deleteSport**
> deleteSport()
### Example
```typescript
import {
SportsApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new SportsApi(configuration);
let id: string; //ID du sport (default to undefined)
const { status, data } = await apiInstance.deleteSport(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | ID du sport | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Sport supprimé | - |
|**401** | Non autorisé | - |
|**404** | Sport non trouvé | - |
|**500** | Erreur serveur interne | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getAllSports**
> Array<Sport> getAllSports(getAllSportsRequest)
### Example
```typescript
import {
SportsApi,
Configuration,
GetAllSportsRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new SportsApi(configuration);
let getAllSportsRequest: GetAllSportsRequest; //
const { status, data } = await apiInstance.getAllSports(
getAllSportsRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **getAllSportsRequest** | **GetAllSportsRequest**| | |
### Return type
**Array<Sport>**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Liste des sports | - |
|**400** | Requête invalide | - |
|**401** | Non autorisé | - |
|**500** | Erreur serveur interne | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **updateSport**
> Sport updateSport(updateSportRequest)
### Example
```typescript
import {
SportsApi,
Configuration,
UpdateSportRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new SportsApi(configuration);
let id: string; //ID du sport (default to undefined)
let updateSportRequest: UpdateSportRequest; //
const { status, data } = await apiInstance.updateSport(
id,
updateSportRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateSportRequest** | **UpdateSportRequest**| | |
| **id** | [**string**] | ID du sport | defaults to undefined|
### Return type
**Sport**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Sport mis à jour | - |
|**401** | Non autorisé | - |
|**404** | Sport non trouvé | - |
|**500** | Erreur serveur interne | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)