UNPKG

@tennac-booking/sdk

Version:

OpenAPI client for @tennac-booking/sdk

181 lines (120 loc) 4.42 kB
# SportsManagerApi All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**createSport**](#createsport) | **POST** /api/sports | | |[**deleteSport**](#deletesport) | **DELETE** /api/sports/{id} | | |[**updateSport**](#updatesport) | **PUT** /api/sports/{id} | | # **createSport** > SportResponse createSport(createSportRequest) Crée un sport (global) avec createdBy = clubId de l\'utilisateur ### Example ```typescript import { SportsManagerApi, Configuration, CreateSportRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new SportsManagerApi(configuration); let createSportRequest: CreateSportRequest; // const { status, data } = await apiInstance.createSport( createSportRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **createSportRequest** | **CreateSportRequest**| | | ### Return type **SportResponse** ### 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** | Bad Request | - | |**401** | Unauthorized | - | |**409** | Conflict | - | |**500** | Server Error | - | [[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** > DeleteSportResponse deleteSport() Supprime un sport (interdit si vérifié) ### Example ```typescript import { SportsManagerApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new SportsManagerApi(configuration); let id: string; // (default to undefined) const { status, data } = await apiInstance.deleteSport( id ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**string**] | | defaults to undefined| ### Return type **DeleteSportResponse** ### 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** | Unauthorized | - | |**403** | Forbidden - Sport vérifié non supprimable | - | |**404** | Sport non trouvé | - | |**500** | Server Error | - | [[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** > SportResponse updateSport(updateSportRequest) Met à jour un sport (interdit si vérifié) ### Example ```typescript import { SportsManagerApi, Configuration, UpdateSportRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new SportsManagerApi(configuration); let id: string; // (default to undefined) let updateSportRequest: UpdateSportRequest; // const { status, data } = await apiInstance.updateSport( id, updateSportRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **updateSportRequest** | **UpdateSportRequest**| | | | **id** | [**string**] | | defaults to undefined| ### Return type **SportResponse** ### 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** | Unauthorized | - | |**403** | Forbidden - Sport vérifié non modifiable | - | |**404** | Sport non trouvé | - | |**500** | Server Error | - | [[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)