@tennac-booking/sdk 1.0.81 → 1.0.82

package/docs/ClubAnalyticsStaffApi.md

@@ -0,0 +1,690 @@
+# ClubAnalyticsStaffApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAnalyticsBySport**](#getanalyticsbysport) | **GET** /api/club-analytics/sport/{sportId}/analytics | |
+|[**getClubPlayerBookingsById**](#getclubplayerbookingsbyid) | **GET** /api/club-analytics/players/{playerId}/bookings | |
+|[**getClubPlayerById**](#getclubplayerbyid) | **GET** /api/club-analytics/players/{playerId} | |
+|[**getClubPlayerStatisticsById**](#getclubplayerstatisticsbyid) | **GET** /api/club-analytics/players/{playerId}/statistics | |
+|[**getClubPlayers**](#getclubplayers) | **GET** /api/club-analytics/players | |
+|[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/club-analytics/daily-turnover | |
+|[**getGenderPercentage**](#getgenderpercentage) | **GET** /api/club-analytics/gender-percentage | |
+|[**getInfillPercentagePerPeriod**](#getinfillpercentageperperiod) | **GET** /api/club-analytics/infill-percentage | |
+|[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/club-analytics/last-six-months-turnover | |
+|[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/club-analytics/monthly-turnover | |
+|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/club-analytics/users-count | |
+|[**getTenNextBookings**](#gettennextbookings) | **GET** /api/club-analytics/next-bookings | |
+|[**getYearlyTurnOver**](#getyearlyturnover) | **GET** /api/club-analytics/yearly-turnover | |
+
+# **getAnalyticsBySport**
+> SportAnalyticsResponse getAnalyticsBySport()
+
+Récupère les analytics par sport
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let sportId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getAnalyticsBySport(
+    sportId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sportId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SportAnalyticsResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Analytics du sport |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getClubPlayerBookingsById**
+> ClubPlayerBookingsResponse getClubPlayerBookingsById()
+
+Récupère les réservations d\'un joueur par son ID (à venir et passées)
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let playerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClubPlayerBookingsById(
+    playerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **playerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClubPlayerBookingsResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Réservations du joueur |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getClubPlayerById**
+> ClubPlayerDetailResponse getClubPlayerById()
+
+Récupère les informations détaillées d\'un joueur par son ID
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let playerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClubPlayerById(
+    playerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **playerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClubPlayerDetailResponse**
+
+### 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 joueur |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not Found |  -  |
+|**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)
+
+# **getClubPlayerStatisticsById**
+> ClubPlayerStatisticsResponse getClubPlayerStatisticsById()
+
+Récupère les statistiques d\'un joueur pour le staff
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let playerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClubPlayerStatisticsById(
+    playerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **playerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClubPlayerStatisticsResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Statistiques du joueur |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not Found |  -  |
+|**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)
+
+# **getClubPlayers**
+> Array<ClubPlayerResponse> getClubPlayers()
+
+Récupère la liste des joueurs du club
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+const { status, data } = await apiInstance.getClubPlayers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ClubPlayerResponse>**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Liste des joueurs du club |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getDailyTurnOver**
+> DailyTurnoverResponse getDailyTurnOver()
+
+Récupère le chiffre d\'affaires quotidien
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let date: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDailyTurnOver(
+    date
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **date** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DailyTurnoverResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Chiffre d\&#39;affaires quotidien |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getGenderPercentage**
+> GenderPercentageResponse getGenderPercentage()
+
+Récupère les pourcentages par genre
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+const { status, data } = await apiInstance.getGenderPercentage();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GenderPercentageResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pourcentages par genre |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getInfillPercentagePerPeriod**
+> GetInfillPercentagePerPeriod200Response getInfillPercentagePerPeriod()
+
+Récupère le taux de remplissage (infill) pour une période donnée
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let startDate: string; // (optional) (default to undefined)
+let endDate: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getInfillPercentagePerPeriod(
+    startDate,
+    endDate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **startDate** | [**string**] |  | (optional) defaults to undefined|
+| **endDate** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetInfillPercentagePerPeriod200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Taux de remplissage |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getLastSixMonthsTurnover**
+> Array<LastSixMonthsTurnoverItem> getLastSixMonthsTurnover()
+
+Récupère le chiffre d\'affaires des 6 derniers mois
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+const { status, data } = await apiInstance.getLastSixMonthsTurnover();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<LastSixMonthsTurnoverItem>**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Chiffre d\&#39;affaires des 6 derniers mois |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getMonthlyTurnOver**
+> MonthlyTurnoverResponse getMonthlyTurnOver()
+
+Récupère le chiffre d\'affaires mensuel
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let year: string; // (default to undefined)
+let month: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getMonthlyTurnOver(
+    year,
+    month
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **year** | [**string**] |  | defaults to undefined|
+| **month** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MonthlyTurnoverResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Chiffre d\&#39;affaires mensuel |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getNumberOfClubUsers**
+> ClubUserCountResponse getNumberOfClubUsers()
+
+Récupère le nombre d\'utilisateurs du club
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+const { status, data } = await apiInstance.getNumberOfClubUsers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ClubUserCountResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Nombre d\&#39;utilisateurs |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getTenNextBookings**
+> Array<BookingAnalyticsResponse> getTenNextBookings()
+
+Récupère les 10 prochaines réservations
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+const { status, data } = await apiInstance.getTenNextBookings();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<BookingAnalyticsResponse>**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prochaines réservations |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+
+# **getYearlyTurnOver**
+> YearlyTurnoverResponse getYearlyTurnOver()
+
+Récupère le chiffre d\'affaires annuel avec détail mensuel
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let year: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getYearlyTurnOver(
+    year
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **year** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**YearlyTurnoverResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Chiffre d\&#39;affaires annuel |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**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)
+

package/docs/ClubMemberResponse.md

@@ -0,0 +1,24 @@
+# ClubMemberResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**ClubMemberResponseUser**](ClubMemberResponseUser.md) |  | [default to undefined]
+**role** | **string** | Rôle du membre dans le club | [default to undefined]
+**rights** | **Array<string>** | Droits du membre dans le club | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubMemberResponse } from '@tennac-booking/sdk';
+
+const instance: ClubMemberResponse = {
+    user,
+    role,
+    rights,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)