@tennac-booking/sdk 1.0.37 → 1.0.40

package/docs/StaffClubAnalyticsApi.md

@@ -0,0 +1,254 @@
+# StaffClubAnalyticsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getClubPlayers**](#getclubplayers) | **GET** /api/analytics/players | Récupère la liste des joueurs du club (données staff uniquement)|
+|[**getGenderPercentage**](#getgenderpercentage) | **GET** /api/analytics/gender | Récupère le pourcentage de joueurs par genre pour le club courant|
+|[**getInfillPercentagePerPeriod**](#getinfillpercentageperperiod) | **GET** /api/analytics/infill-percentage | Taux de remplissage des créneaux pour une période donnée (club courant)|
+|[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/analytics/lastSixMonthsTurnover | Get monthly turnover for the last six months (club courant)|
+|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/analytics/user-count | Get number of users subscribed to the club|
+
+# **getClubPlayers**
+> Array<UserStaffResponse> getClubPlayers()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubAnalyticsApi(configuration);
+
+const { status, data } = await apiInstance.getClubPlayers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<UserStaffResponse>**
+
+### 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 |  -  |
+|**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)
+
+# **getGenderPercentage**
+> GenderPercentage getGenderPercentage()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubAnalyticsApi(configuration);
+
+const { status, data } = await apiInstance.getGenderPercentage();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GenderPercentage**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pourcentage de joueurs par genre |  -  |
+|**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)
+
+# **getInfillPercentagePerPeriod**
+> GetInfillPercentagePerPeriod200Response getInfillPercentagePerPeriod()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubAnalyticsApi(configuration);
+
+let startDate: string; //Date de début (format ISO) (default to undefined)
+let endDate: string; //Date de fin (format ISO) (default to undefined)
+
+const { status, data } = await apiInstance.getInfillPercentagePerPeriod(
+    startDate,
+    endDate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **startDate** | [**string**] | Date de début (format ISO) | defaults to undefined|
+| **endDate** | [**string**] | Date de fin (format ISO) | 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 calculé |  -  |
+|**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)
+
+# **getLastSixMonthsTurnover**
+> Array<GetLastSixMonthsTurnover200ResponseInner> getLastSixMonthsTurnover()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubAnalyticsApi(configuration);
+
+const { status, data } = await apiInstance.getLastSixMonthsTurnover();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<GetLastSixMonthsTurnover200ResponseInner>**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Turnover data for the last 6 months |  -  |
+|**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)
+
+# **getNumberOfClubUsers**
+> GetNumberOfClubUsers200Response getNumberOfClubUsers()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubAnalyticsApi(configuration);
+
+let id: string; //ID du club (optionnel, si absent, pris depuis le token) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getNumberOfClubUsers(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club (optionnel, si absent, pris depuis le token) | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetNumberOfClubUsers200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Number of subscribed users |  -  |
+|**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)
+

package/docs/StaffClubBookingsApi.md

@@ -0,0 +1,52 @@
+# StaffClubBookingsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getTenNextBookings**](#gettennextbookings) | **GET** /api/analytics/next-bookings | Get the ten next bookings for the current club|
+
+# **getTenNextBookings**
+> Array<BookingPopulated> getTenNextBookings()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubBookingsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubBookingsApi(configuration);
+
+const { status, data } = await apiInstance.getTenNextBookings();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<BookingPopulated>**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of next bookings |  -  |
+|**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)
+

package/docs/StaffClubsApi.md

@@ -0,0 +1,147 @@
+# StaffClubsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getClubInfos**](#getclubinfos) | **GET** /api/clubs/infos | Get current club information|
+|[**getClubSettings**](#getclubsettings) | **GET** /api/club-settings | Récupère les paramètres d’un club|
+|[**getSports**](#getsports) | **GET** /api/sports | Récupère la liste des sports du club courant|
+
+# **getClubInfos**
+> GetClubInfos200Response getClubInfos()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubsApi(configuration);
+
+const { status, data } = await apiInstance.getClubInfos();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetClubInfos200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Club information |  -  |
+|**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)
+
+# **getClubSettings**
+> ClubSettings getClubSettings()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubsApi(configuration);
+
+const { status, data } = await apiInstance.getClubSettings();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ClubSettings**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paramètres du club |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**404** | Paramètres non trouvés |  -  |
+|**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)
+
+# **getSports**
+> Array<SportResponse> getSports()
+
+
+### Example
+
+```typescript
+import {
+    StaffClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffClubsApi(configuration);
+
+const { status, data } = await apiInstance.getSports();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<SportResponse>**
+
+### 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 sports |  -  |
+|**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)
+

package/docs/StaffEventResponse.md

@@ -0,0 +1,20 @@
+# StaffEventResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<Event>**](Event.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StaffEventResponse } from '@tennac-booking/sdk';
+
+const instance: StaffEventResponse = {
+    events,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StaffEventsApi.md

@@ -0,0 +1,54 @@
+# StaffEventsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getEventsByClub**](#geteventsbyclub) | **GET** /api/events/staff/getEvents | Get all events for current club (including unpublished)|
+
+# **getEventsByClub**
+> StaffEventResponse getEventsByClub()
+
+
+### Example
+
+```typescript
+import {
+    StaffEventsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffEventsApi(configuration);
+
+const { status, data } = await apiInstance.getEventsByClub();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**StaffEventResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of all events |  -  |
+|**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)
+

package/docs/StaffProfileApi.md

@@ -0,0 +1,110 @@
+# StaffProfileApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getUserProfileStaff**](#getuserprofilestaff) | **GET** /api/users/staff/profile/:id | Récupère le profil d\'un utilisateur par son ID (données staff uniquement)|
+|[**getUserRolesInClubs**](#getuserrolesinclubs) | **GET** /api/users/me/roles | Récupère les rôles de l\'utilisateur dans les clubs|
+
+# **getUserProfileStaff**
+> UserInfoStaff getUserProfileStaff()
+
+
+### Example
+
+```typescript
+import {
+    StaffProfileApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffProfileApi(configuration);
+
+let id: string; //ID de l\'utilisateur (default to undefined)
+
+const { status, data } = await apiInstance.getUserProfileStaff(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID de l\'utilisateur | defaults to undefined|
+
+
+### Return type
+
+**UserInfoStaff**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Profil utilisateur |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**404** | Ressource non trouvée |  -  |
+|**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)
+
+# **getUserRolesInClubs**
+> GetUserRolesResponse getUserRolesInClubs()
+
+
+### Example
+
+```typescript
+import {
+    StaffProfileApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StaffProfileApi(configuration);
+
+const { status, data } = await apiInstance.getUserRolesInClubs();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetUserRolesResponse**
+
+### 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 rôles dans les clubs |  -  |
+|**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)
+

package/docs/StaffUserProfileResponse.md

@@ -0,0 +1,22 @@
+# StaffUserProfileResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**isSubscribedToMyClub** | **boolean** |  | [optional] [default to undefined]
+**creditOnMyClub** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StaffUserProfileResponse } from '@tennac-booking/sdk';
+
+const instance: StaffUserProfileResponse = {
+    isSubscribedToMyClub,
+    creditOnMyClub,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SubscribeToClubRequestBody.md

@@ -0,0 +1,22 @@
+# SubscribeToClubRequestBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clubId** | **string** |  | [default to undefined]
+**priceId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SubscribeToClubRequestBody } from '@tennac-booking/sdk';
+
+const instance: SubscribeToClubRequestBody = {
+    clubId,
+    priceId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SubscriptionMutationResponse.md

@@ -0,0 +1,20 @@
+# SubscriptionMutationResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription** | **{ [key: string]: any; }** | Construct a type with a set of properties K of type T | [default to undefined]
+
+## Example
+
+```typescript
+import { SubscriptionMutationResponse } from '@tennac-booking/sdk';
+
+const instance: SubscriptionMutationResponse = {
+    subscription,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)