@tennac-booking/sdk 1.0.55 → 1.0.60

package/docs/SdkDiagnosticsResponse.md

@@ -1,28 +0,0 @@
-# SdkDiagnosticsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **string** | Etat de la vérification (\'ok\' si tout s\'est bien passé) | [default to undefined]
-**apiVersion** | **string** | Version courante définie dans package.json | [default to undefined]
-**openapi** | [**SdkDiagnosticsResponseOpenapi**](SdkDiagnosticsResponseOpenapi.md) |  | [default to undefined]
-**sdk** | [**SdkDiagnosticsResponseSdk**](SdkDiagnosticsResponseSdk.md) |  | [default to undefined]
-**matchesApiVersion** | **boolean** | true si openapi.json et le SDK sont alignés avec la version de l\'API | [default to undefined]
-
-## Example
-
-```typescript
-import { SdkDiagnosticsResponse } from '@tennac-booking/sdk';
-
-const instance: SdkDiagnosticsResponse = {
-    status,
-    apiVersion,
-    openapi,
-    sdk,
-    matchesApiVersion,
-};
-```
-
-[[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/SdkDiagnosticsResponseOpenapi.md

@@ -1,24 +0,0 @@
-# SdkDiagnosticsResponseOpenapi
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**exists** | **boolean** |  | [optional] [default to undefined]
-**version** | **string** | Version trouvée dans openapi.json | [optional] [default to undefined]
-**path** | **string** | Chemin relatif vers openapi.json | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SdkDiagnosticsResponseOpenapi } from '@tennac-booking/sdk';
-
-const instance: SdkDiagnosticsResponseOpenapi = {
-    exists,
-    version,
-    path,
-};
-```
-
-[[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/SdkDiagnosticsResponseSdk.md

@@ -1,24 +0,0 @@
-# SdkDiagnosticsResponseSdk
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**exists** | **boolean** |  | [optional] [default to undefined]
-**version** | **string** | Version du package SDK généré | [optional] [default to undefined]
-**path** | **string** | Chemin relatif vers sdk/package.json | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SdkDiagnosticsResponseSdk } from '@tennac-booking/sdk';
-
-const instance: SdkDiagnosticsResponseSdk = {
-    exists,
-    version,
-    path,
-};
-```
-
-[[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/Slot.md

@@ -1,24 +0,0 @@
-# Slot
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**startDate** | **string** |  | [default to undefined]
-**endDate** | **string** |  | [default to undefined]
-**courtId** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { Slot } from '@tennac-booking/sdk';
-
-const instance: Slot = {
-    startDate,
-    endDate,
-    courtId,
-};
-```
-
-[[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/SlotException.md

@@ -1,26 +0,0 @@
-# SlotException
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**startDate** | **string** |  | [default to undefined]
-**endDate** | **string** |  | [default to undefined]
-**courtId** | **string** |  | [default to undefined]
-**reason** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { SlotException } from '@tennac-booking/sdk';
-
-const instance: SlotException = {
-    startDate,
-    endDate,
-    courtId,
-    reason,
-};
-```
-
-[[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/SlotResponse.md

@@ -1,34 +0,0 @@
-# SlotResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**startDate** | **string** |  | [optional] [default to undefined]
-**endDate** | **string** |  | [optional] [default to undefined]
-**courtId** | **string** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-**isOpen** | **boolean** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SlotResponse } from '@tennac-booking/sdk';
-
-const instance: SlotResponse = {
-    id,
-    startDate,
-    endDate,
-    courtId,
-    price,
-    isOpen,
-    createdAt,
-    updatedAt,
-};
-```
-
-[[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/StaffBookingsApi.md

@@ -1,61 +0,0 @@
-# StaffBookingsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getBookingByIdStaff**](#getbookingbyidstaff) | **GET** /api/bookings/staff/:bookingId | Récupère une réservation par son ID avec les joueurs et terrains (incluant le sport) peuplés.|
-
-# **getBookingByIdStaff**
-> BookingPopulated getBookingByIdStaff()
-
-
-### Example
-
-```typescript
-import {
-    StaffBookingsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new StaffBookingsApi(configuration);
-
-let bookingId: string; //ID de la réservation (default to undefined)
-
-const { status, data } = await apiInstance.getBookingByIdStaff(
-    bookingId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **bookingId** | [**string**] | ID de la réservation | defaults to undefined|
-
-
-### Return type
-
-**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** | Réservation récupérée avec succès |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**403** | Accès interdit |  -  |
-
-[[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/StaffClubAnalyticsApi.md

@@ -1,254 +0,0 @@
-# StaffClubAnalyticsApi
-
-All URIs are relative to *http://localhost*
-
-|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/StripeLink.md

@@ -1,26 +0,0 @@
-# StripeLink
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clubId** | **string** |  | [optional] [default to undefined]
-**clubPicture** | **string** |  | [optional] [default to undefined]
-**clubName** | **string** |  | [optional] [default to undefined]
-**portalUrl** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { StripeLink } from '@tennac-booking/sdk';
-
-const instance: StripeLink = {
-    clubId,
-    clubPicture,
-    clubName,
-    portalUrl,
-};
-```
-
-[[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/StripeStatus.md

@@ -1,16 +0,0 @@
-# StripeStatus
-
-
-## Enum
-
-* `Pending` (value: `'pending'`)
-
-* `Paid` (value: `'paid'`)
-
-* `Failed` (value: `'failed'`)
-
-* `Refunded` (value: `'refunded'`)
-
-* `Canceled` (value: `'canceled'`)
-
-[[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/SubscriptionPlan.md

@@ -1,36 +0,0 @@
-# SubscriptionPlan
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**stripeProductId** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**clubId** | **string** |  | [optional] [default to undefined]
-**isActive** | **boolean** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**prices** | [**Array<PriceResponse>**](PriceResponse.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SubscriptionPlan } from '@tennac-booking/sdk';
-
-const instance: SubscriptionPlan = {
-    id,
-    stripeProductId,
-    name,
-    description,
-    clubId,
-    isActive,
-    createdAt,
-    updatedAt,
-    prices,
-};
-```
-
-[[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/SubscriptionResponse.md

@@ -1,36 +0,0 @@
-# SubscriptionResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | ID de l\'abonnement | [optional] [default to undefined]
-**userId** | **string** | ID de l\'utilisateur | [optional] [default to undefined]
-**clubId** | **string** | ID du club | [optional] [default to undefined]
-**stripeSubscriptionId** | **string** | ID de l\'abonnement Stripe | [optional] [default to undefined]
-**status** | **string** | Statut de l\'abonnement | [optional] [default to undefined]
-**currentPeriodStart** | **string** | Début de la période courante | [optional] [default to undefined]
-**currentPeriodEnd** | **string** | Fin de la période courante | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SubscriptionResponse } from '@tennac-booking/sdk';
-
-const instance: SubscriptionResponse = {
-    id,
-    userId,
-    clubId,
-    stripeSubscriptionId,
-    status,
-    currentPeriodStart,
-    currentPeriodEnd,
-    createdAt,
-    updatedAt,
-};
-```
-
-[[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/UpdateClubRoleRequestBody.md

@@ -1,24 +0,0 @@
-# UpdateClubRoleRequestBody
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** | Nouveau nom du rôle (optionnel) | [optional] [default to undefined]
-**description** | **string** | Nouvelle description du rôle (optionnel) | [optional] [default to undefined]
-**permissions** | **Array<string>** | Nouvelle liste de permissions (optionnel) | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateClubRoleRequestBody } from '@tennac-booking/sdk';
-
-const instance: UpdateClubRoleRequestBody = {
-    name,
-    description,
-    permissions,
-};
-```
-
-[[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/UpdateCourtRequest.md

@@ -1,38 +0,0 @@
-# UpdateCourtRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** | Nom du terrain | [default to undefined]
-**status** | **string** | Statut du terrain | [default to undefined]
-**comments** | **string** | Commentaires sur le terrain | [optional] [default to undefined]
-**slotDefaultDuration** | **number** | Durée par défaut d’un créneau (en minutes) | [default to undefined]
-**pricePerHourInCents** | **number** | Prix par créneau en centimes | [optional] [default to undefined]
-**startTimeInTheDayInMinutes** | **number** | Heure de début (minutes depuis minuit) | [default to undefined]
-**endTimeInTheDayInMinutes** | **number** | Heure de fin (minutes depuis minuit) | [default to undefined]
-**sportId** | **string** | ID du sport associé | [default to undefined]
-**surface** | **string** | Type de surface | [default to undefined]
-**isIndoor** | **boolean** | Terrain intérieur ou extérieur | [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateCourtRequest } from '@tennac-booking/sdk';
-
-const instance: UpdateCourtRequest = {
-    name,
-    status,
-    comments,
-    slotDefaultDuration,
-    pricePerHourInCents,
-    startTimeInTheDayInMinutes,
-    endTimeInTheDayInMinutes,
-    sportId,
-    surface,
-    isIndoor,
-};
-```
-
-[[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/UpdateProfilePictureRequestBody.md

@@ -1,20 +0,0 @@
-# UpdateProfilePictureRequestBody
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**profilePicture** | **string** | URL distante de la photo de profil (AWS/GCP) | [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateProfilePictureRequestBody } from '@tennac-booking/sdk';
-
-const instance: UpdateProfilePictureRequestBody = {
-    profilePicture,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)