@tennac-booking/sdk 1.0.97 → 1.0.98

package/docs/ClubSettingsStaffApi.md

@@ -1,183 +0,0 @@
-# ClubSettingsStaffApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getClubGeneralSettings**](#getclubgeneralsettings) | **GET** /api/club-settings/settings/general | |
-|[**getHoursSettings**](#gethourssettings) | **GET** /api/club-settings/hours | |
-|[**getPresentationSettings**](#getpresentationsettings) | **GET** /api/club-settings/presentation | |
-|[**getReservationSettings**](#getreservationsettings) | **GET** /api/club-settings/reservation | |
-
-# **getClubGeneralSettings**
-> ClubGeneralSettingsResponse getClubGeneralSettings()
-
-
-### Example
-
-```typescript
-import {
-    ClubSettingsStaffApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ClubSettingsStaffApi(configuration);
-
-const { status, data } = await apiInstance.getClubGeneralSettings();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ClubGeneralSettingsResponse**
-
-### 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 généraux 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)
-
-# **getHoursSettings**
-> ClubHoursSettingsResponse getHoursSettings()
-
-
-### Example
-
-```typescript
-import {
-    ClubSettingsStaffApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ClubSettingsStaffApi(configuration);
-
-const { status, data } = await apiInstance.getHoursSettings();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ClubHoursSettingsResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Horaires 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)
-
-# **getPresentationSettings**
-> ClubPresentationSettingsResponse getPresentationSettings()
-
-
-### Example
-
-```typescript
-import {
-    ClubSettingsStaffApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ClubSettingsStaffApi(configuration);
-
-const { status, data } = await apiInstance.getPresentationSettings();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ClubPresentationSettingsResponse**
-
-### 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 de présentation 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)
-
-# **getReservationSettings**
-> ClubReservationSettingsResponse getReservationSettings()
-
-
-### Example
-
-```typescript
-import {
-    ClubSettingsStaffApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ClubSettingsStaffApi(configuration);
-
-const { status, data } = await apiInstance.getReservationSettings();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ClubReservationSettingsResponse**
-
-### 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 de réservation 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)
-

package/docs/ClubWeeklySchedule.md

@@ -1,32 +0,0 @@
-# ClubWeeklySchedule
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sunday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [default to undefined]
-**saturday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [default to undefined]
-**friday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [default to undefined]
-**thursday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [default to undefined]
-**wednesday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [default to undefined]
-**tuesday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [default to undefined]
-**monday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ClubWeeklySchedule } from '@tennac-booking/sdk';
-
-const instance: ClubWeeklySchedule = {
-    sunday,
-    saturday,
-    friday,
-    thursday,
-    wednesday,
-    tuesday,
-    monday,
-};
-```
-
-[[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/CourtBookingShareItem.md

@@ -1,26 +0,0 @@
-# CourtBookingShareItem
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**courtId** | **string** | ID du terrain | [default to undefined]
-**courtName** | **string** | Nom du terrain | [default to undefined]
-**bookingPercentage** | **number** | Pourcentage des réservations associées à ce terrain | [default to undefined]
-**totalBookings** | **number** | Nombre total de réservations utilisant ce terrain | [default to undefined]
-
-## Example
-
-```typescript
-import { CourtBookingShareItem } from '@tennac-booking/sdk';
-
-const instance: CourtBookingShareItem = {
-    courtId,
-    courtName,
-    bookingPercentage,
-    totalBookings,
-};
-```
-
-[[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/PartialClubWeeklySchedule.md

@@ -1,33 +0,0 @@
-# PartialClubWeeklySchedule
-
-Make all properties in T optional
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**monday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [optional] [default to undefined]
-**tuesday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [optional] [default to undefined]
-**wednesday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [optional] [default to undefined]
-**thursday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [optional] [default to undefined]
-**friday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [optional] [default to undefined]
-**saturday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [optional] [default to undefined]
-**sunday** | [**ClubDaySchedule**](ClubDaySchedule.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PartialClubWeeklySchedule } from '@tennac-booking/sdk';
-
-const instance: PartialClubWeeklySchedule = {
-    monday,
-    tuesday,
-    wednesday,
-    thursday,
-    friday,
-    saturday,
-    sunday,
-};
-```
-
-[[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/RetentionRateResponse.md

@@ -1,24 +0,0 @@
-# RetentionRateResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**retentionRate** | **number** | Pourcentage de joueurs fidèles (>= 2 réservations) | [default to undefined]
-**loyalPlayers** | **number** | Nombre de joueurs fidèles | [default to undefined]
-**totalPlayers** | **number** | Nombre total de joueurs ayant réservé | [default to undefined]
-
-## Example
-
-```typescript
-import { RetentionRateResponse } from '@tennac-booking/sdk';
-
-const instance: RetentionRateResponse = {
-    retentionRate,
-    loyalPlayers,
-    totalPlayers,
-};
-```
-
-[[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/RevenueBySportItem.md

@@ -1,24 +0,0 @@
-# RevenueBySportItem
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sportId** | **string** | ID du sport | [default to undefined]
-**sportName** | **string** | Nom du sport (si disponible) | [default to undefined]
-**totalTurnover** | **number** | Chiffre d\'affaires total pour ce sport | [default to undefined]
-
-## Example
-
-```typescript
-import { RevenueBySportItem } from '@tennac-booking/sdk';
-
-const instance: RevenueBySportItem = {
-    sportId,
-    sportName,
-    totalTurnover,
-};
-```
-
-[[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/UpdateClubGeneralSettingsRequest.md

@@ -1,34 +0,0 @@
-# UpdateClubGeneralSettingsRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**phone** | **string** |  | [optional] [default to undefined]
-**websiteUrl** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**rib** | **string** |  | [optional] [default to undefined]
-**logo** | **string** |  | [optional] [default to undefined]
-**location** | [**ClubLocationSettings**](ClubLocationSettings.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateClubGeneralSettingsRequest } from '@tennac-booking/sdk';
-
-const instance: UpdateClubGeneralSettingsRequest = {
-    name,
-    email,
-    phone,
-    websiteUrl,
-    description,
-    rib,
-    logo,
-    location,
-};
-```
-
-[[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/UpdateClubHoursSettingsRequest.md

@@ -1,22 +0,0 @@
-# UpdateClubHoursSettingsRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**schedule** | [**PartialClubWeeklySchedule**](PartialClubWeeklySchedule.md) |  | [optional] [default to undefined]
-**pricingPeriods** | [**Array<ClubPricingPeriodResponse>**](ClubPricingPeriodResponse.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateClubHoursSettingsRequest } from '@tennac-booking/sdk';
-
-const instance: UpdateClubHoursSettingsRequest = {
-    schedule,
-    pricingPeriods,
-};
-```
-
-[[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/UpdateClubPresentationSettingsRequest.md

@@ -1,26 +0,0 @@
-# UpdateClubPresentationSettingsRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**description** | **string** |  | [optional] [default to undefined]
-**tags** | **Array<string>** |  | [optional] [default to undefined]
-**bannerImages** | **Array<string | null>** |  | [optional] [default to undefined]
-**galleryImages** | **Array<string | null>** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateClubPresentationSettingsRequest } from '@tennac-booking/sdk';
-
-const instance: UpdateClubPresentationSettingsRequest = {
-    description,
-    tags,
-    bannerImages,
-    galleryImages,
-};
-```
-
-[[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/UpdateClubReservationSettingsRequest.md

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