@tennac-booking/sdk 1.0.54 → 1.0.60

package/docs/ClubAnalyticsApi.md

@@ -4,14 +4,13 @@ All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/analytics/dailyTurnover | Chiffre d\'affaires quotidien (club courant)|
-|[**getInvoices**](#getinvoices) | **GET** /api/clubs/invoices | Récupérer les factures du club courant|
-|[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/analytics/monthlyTurnover | Chiffre d\'affaires mensuel (club courant)|
-|[**getYearlyTurnOver**](#getyearlyturnover) | **GET** /api/analytics/yearlyTurnover | Chiffre d\'affaires annuel (club courant)|
+|[**getMostLikedClub**](#getmostlikedclub) | **GET** /api/club-analytics/most-liked-clubs | |
+|[**getPopularClubs**](#getpopularclubs) | **GET** /api/club-analytics/popular-clubs | |
 
-# **getDailyTurnOver**
-> DailyTurnoverResponse getDailyTurnOver()
+# **getMostLikedClub**
+> Array<any> getMostLikedClub()
 
+Récupère les clubs les plus aimés
 
 ### Example
 
@@ -24,23 +23,16 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClubAnalyticsApi(configuration);
 
-let date: string; //Date (format YYYY-MM-DD) (default to undefined)
-
-const { status, data } = await apiInstance.getDailyTurnOver(
-    date
-);
+const { status, data } = await apiInstance.getMostLikedClub();
 ```
 
 ### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **date** | [**string**] | Date (format YYYY-MM-DD) | defaults to undefined|
+This endpoint does not have any parameters.
 
 
 ### Return type
 
-**DailyTurnoverResponse**
+**Array<any>**
 
 ### Authorization
 
@@ -55,17 +47,16 @@ const { status, data } = await apiInstance.getDailyTurnOver(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Chiffre d\&#39;affaires quotidien |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**403** | Accès interdit |  -  |
-|**500** | Erreur serveur interne |  -  |
+|**200** | Clubs les plus aimés |  -  |
+|**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)
 
-# **getInvoices**
-> InvoicesResponse getInvoices()
+# **getPopularClubs**
+> Array<any> getPopularClubs()
 
+Récupère les clubs populaires
 
 ### Example
 
@@ -78,145 +69,16 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClubAnalyticsApi(configuration);
 
-let page: number; //Numéro de page (optional) (default to 1)
-let limit: number; //Nombre d\'éléments par page (optional) (default to 10)
-let status: 'pending' | 'paid' | 'failed' | 'authorized' | 'canceled' | 'expired'; //Filtrer par statut (optional) (default to undefined)
-let startDate: string; //Date de début (ISO format) (optional) (default to undefined)
-let endDate: string; //Date de fin (ISO format) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getInvoices(
-    page,
-    limit,
-    status,
-    startDate,
-    endDate
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **page** | [**number**] | Numéro de page | (optional) defaults to 1|
-| **limit** | [**number**] | Nombre d\&#39;éléments par page | (optional) defaults to 10|
-| **status** | [**&#39;pending&#39; | &#39;paid&#39; | &#39;failed&#39; | &#39;authorized&#39; | &#39;canceled&#39; | &#39;expired&#39;**]**Array<&#39;pending&#39; &#124; &#39;paid&#39; &#124; &#39;failed&#39; &#124; &#39;authorized&#39; &#124; &#39;canceled&#39; &#124; &#39;expired&#39;>** | Filtrer par statut | (optional) defaults to undefined|
-| **startDate** | [**string**] | Date de début (ISO format) | (optional) defaults to undefined|
-| **endDate** | [**string**] | Date de fin (ISO format) | (optional) defaults to undefined|
-
-
-### Return type
-
-**InvoicesResponse**
-
-### 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 factures |  -  |
-|**401** | Non autorisé |  -  |
-|**403** | Accès interdit |  -  |
-|**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)
-
-# **getMonthlyTurnOver**
-> MonthlyTurnoverResponse getMonthlyTurnOver()
-
-
-### Example
-
-```typescript
-import {
-    ClubAnalyticsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ClubAnalyticsApi(configuration);
-
-let year: number; //Année (default to undefined)
-let month: number; //Mois (1-12) (default to undefined)
-
-const { status, data } = await apiInstance.getMonthlyTurnOver(
-    year,
-    month
-);
+const { status, data } = await apiInstance.getPopularClubs();
 ```
 
 ### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **year** | [**number**] | Année | defaults to undefined|
-| **month** | [**number**] | Mois (1-12) | 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** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**403** | Accès interdit |  -  |
-|**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)
-
-# **getYearlyTurnOver**
-> YearlyTurnoverResponse getYearlyTurnOver()
-
-
-### Example
-
-```typescript
-import {
-    ClubAnalyticsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ClubAnalyticsApi(configuration);
-
-let year: number; //Année (default to undefined)
-
-const { status, data } = await apiInstance.getYearlyTurnOver(
-    year
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **year** | [**number**] | Année | defaults to undefined|
+This endpoint does not have any parameters.
 
 
 ### Return type
 
-**YearlyTurnoverResponse**
+**Array<any>**
 
 ### Authorization
 
@@ -231,11 +93,9 @@ const { status, data } = await apiInstance.getYearlyTurnOver(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Chiffre d\&#39;affaires annuel |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**403** | Accès interdit |  -  |
-|**500** | Erreur serveur interne |  -  |
+|**200** | Clubs populaires |  -  |
+|**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)