@tennac-booking/sdk 1.0.81 → 1.0.82

package/docs/ClubsApi.md

@@ -0,0 +1,614 @@
+# ClubsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getActiveClubs**](#getactiveclubs) | **GET** /api/clubs/active | |
+|[**getAllClubs**](#getallclubs) | **GET** /api/clubs | |
+|[**getAvailableSlotsByClubById**](#getavailableslotsbyclubbyid) | **GET** /api/clubs/{clubID}/availableSlots | |
+|[**getAvailableSlotsBySports**](#getavailableslotsbysports) | **GET** /api/clubs/{id}/sports/{sportId}/slots | |
+|[**getAvailableSlotsBySportsAndDay**](#getavailableslotsbysportsandday) | **GET** /api/clubs/{id}/sports/{sportId}/slots/{day} | |
+|[**getClubInfo**](#getclubinfo) | **GET** /api/clubs/info | |
+|[**getClubUsersById**](#getclubusersbyid) | **GET** /api/clubs/{id}/users | |
+|[**getClubsWithVerificationDomains**](#getclubswithverificationdomains) | **GET** /api/clubs/verification-domains | |
+|[**getCourtsByClubAndSportById**](#getcourtsbyclubandsportbyid) | **GET** /api/clubs/{id}/sports/{sportId}/courts | |
+|[**getPublishedActualities**](#getpublishedactualities) | **GET** /api/clubs/{id}/actualities | |
+|[**getSlotsByClubById**](#getslotsbyclubbyid) | **GET** /api/clubs/{id}/slots | |
+|[**getSportsByClubById**](#getsportsbyclubbyid) | **GET** /api/clubs/{id}/sports | |
+
+# **getActiveClubs**
+> Array<PartialClubResponse> getActiveClubs()
+
+Récupère la liste des clubs actifs
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+const { status, data } = await apiInstance.getActiveClubs();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<PartialClubResponse>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Liste des clubs actifs |  -  |
+|**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)
+
+# **getAllClubs**
+> Array<ClubResponse> getAllClubs()
+
+Récupère la liste de tous les clubs
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+const { status, data } = await apiInstance.getAllClubs();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ClubResponse>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Liste des clubs |  -  |
+|**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)
+
+# **getAvailableSlotsByClubById**
+> GetSlotsByClubById200Response getAvailableSlotsByClubById()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let clubID: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getAvailableSlotsByClubById(
+    clubID
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubID** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetSlotsByClubById200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Available slots |  -  |
+
+[[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)
+
+# **getAvailableSlotsBySports**
+> GetAvailableSlotsBySports200Response getAvailableSlotsBySports()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; // (default to undefined)
+let sportId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getAvailableSlotsBySports(
+    id,
+    sportId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+| **sportId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetAvailableSlotsBySports200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Available slots by sport |  -  |
+
+[[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)
+
+# **getAvailableSlotsBySportsAndDay**
+> GetAvailableSlotsBySports200Response getAvailableSlotsBySportsAndDay()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; // (default to undefined)
+let sportId: string; // (default to undefined)
+let day: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getAvailableSlotsBySportsAndDay(
+    id,
+    sportId,
+    day
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+| **sportId** | [**string**] |  | defaults to undefined|
+| **day** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetAvailableSlotsBySports200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Available slots by sport and day |  -  |
+
+[[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)
+
+# **getClubInfo**
+> ClubResponse getClubInfo()
+
+Récupère les informations d\'un club spécifique
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+const { status, data } = await apiInstance.getClubInfo();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ClubResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Informations du club |  -  |
+|**404** | Club 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)
+
+# **getClubUsersById**
+> GetClubUsersById200Response getClubUsersById()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClubUsersById(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetClubUsersById200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Utilisateurs du club récupérés |  -  |
+|**400** | Bad Request |  -  |
+|**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)
+
+# **getClubsWithVerificationDomains**
+> Array<GetClubsWithVerificationDomains200ResponseInner> getClubsWithVerificationDomains()
+
+Récupère la liste des clubs qui ont des domaines d\'email pour vérification Accessible sans token
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+const { status, data } = await apiInstance.getClubsWithVerificationDomains();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<GetClubsWithVerificationDomains200ResponseInner>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Liste des clubs avec domaines de vérification |  -  |
+|**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)
+
+# **getCourtsByClubAndSportById**
+> GetCourtsByClubAndSportById200Response getCourtsByClubAndSportById()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; // (default to undefined)
+let sportId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getCourtsByClubAndSportById(
+    id,
+    sportId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+| **sportId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetCourtsByClubAndSportById200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Terrains par club et sport |  -  |
+
+[[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)
+
+# **getPublishedActualities**
+> GetActualities200Response getPublishedActualities()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getPublishedActualities(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetActualities200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Actualités publiées |  -  |
+
+[[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)
+
+# **getSlotsByClubById**
+> GetSlotsByClubById200Response getSlotsByClubById()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSlotsByClubById(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetSlotsByClubById200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Slots du club |  -  |
+
+[[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)
+
+# **getSportsByClubById**
+> Array<SportResponse> getSportsByClubById()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSportsByClubById(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<SportResponse>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Liste des sports du club |  -  |
+
+[[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)
+