@tennac-booking/sdk 1.0.54 → 1.0.60

package/docs/DiagnosticsApi.md

@@ -1,97 +0,0 @@
-# DiagnosticsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getSdkDiagnostics**](#getsdkdiagnostics) | **GET** /api/test/sdk-check | Vérifie que la documentation OpenAPI et le SDK sont synchronisés avec la version de l’API|
-|[**ping**](#ping) | **GET** /tsoa-test/ping | |
-
-# **getSdkDiagnostics**
-> SdkDiagnosticsResponse getSdkDiagnostics()
-
-
-### Example
-
-```typescript
-import {
-    DiagnosticsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new DiagnosticsApi(configuration);
-
-const { status, data } = await apiInstance.getSdkDiagnostics();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**SdkDiagnosticsResponse**
-
-### 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ésultat de la vérification |  -  |
-|**500** | Erreur lors de la vérification |  -  |
-
-[[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)
-
-# **ping**
-> DiagnosticsResponse ping()
-
-Endpoint de démonstration généré via TSOA. Permet de valider la configuration du pipeline types -> OpenAPI sans écrire la doc à la main.
-
-### Example
-
-```typescript
-import {
-    DiagnosticsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new DiagnosticsApi(configuration);
-
-const { status, data } = await apiInstance.ping();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**DiagnosticsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Ok |  -  |
-
-[[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/Event.md

@@ -1,40 +0,0 @@
-# Event
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [optional] [default to undefined]
-**clubId** | **string** |  | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**startDate** | **string** |  | [optional] [default to undefined]
-**endDate** | **string** |  | [optional] [default to undefined]
-**courts** | **Array<string>** |  | [optional] [default to undefined]
-**isActive** | **boolean** |  | [optional] [default to undefined]
-**createdBy** | **string** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Event } from '@tennac-booking/sdk';
-
-const instance: Event = {
-    _id,
-    clubId,
-    title,
-    description,
-    startDate,
-    endDate,
-    courts,
-    isActive,
-    createdBy,
-    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/EventBooking.md

@@ -1,32 +0,0 @@
-# EventBooking
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [optional] [default to undefined]
-**eventId** | **string** |  | [optional] [default to undefined]
-**teamName** | **string** |  | [optional] [default to undefined]
-**players** | **Array<string>** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { EventBooking } from '@tennac-booking/sdk';
-
-const instance: EventBooking = {
-    _id,
-    eventId,
-    teamName,
-    players,
-    status,
-    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/EventRegistrationRequest.md

@@ -1,22 +0,0 @@
-# EventRegistrationRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**teamName** | **string** |  | [default to undefined]
-**players** | **Array<string>** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { EventRegistrationRequest } from '@tennac-booking/sdk';
-
-const instance: EventRegistrationRequest = {
-    teamName,
-    players,
-};
-```
-
-[[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/FrequentClub.md

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

@@ -1,28 +0,0 @@
-# FrequentlyPlayedWithItem
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userId** | **string** |  | [optional] [default to undefined]
-**firstName** | **string** |  | [optional] [default to undefined]
-**lastName** | **string** |  | [optional] [default to undefined]
-**profilePicture** | **string** |  | [optional] [default to undefined]
-**playCount** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { FrequentlyPlayedWithItem } from '@tennac-booking/sdk';
-
-const instance: FrequentlyPlayedWithItem = {
-    userId,
-    firstName,
-    lastName,
-    profilePicture,
-    playCount,
-};
-```
-
-[[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/FrequentlyVisitedClubItem.md

@@ -1,24 +0,0 @@
-# FrequentlyVisitedClubItem
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clubId** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**visitCount** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { FrequentlyVisitedClubItem } from '@tennac-booking/sdk';
-
-const instance: FrequentlyVisitedClubItem = {
-    clubId,
-    name,
-    visitCount,
-};
-```
-
-[[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/GetActiveClubs200Response.md

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

@@ -1,30 +0,0 @@
-# GetClubInfos200Response
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [optional] [default to undefined]
-**address** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [optional] [default to undefined]
-**phone** | **string** |  | [optional] [default to undefined]
-**rib** | **string** |  | [optional] [default to undefined]
-**websiteUrl** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetClubInfos200Response } from '@tennac-booking/sdk';
-
-const instance: GetClubInfos200Response = {
-    name,
-    address,
-    email,
-    phone,
-    rib,
-    websiteUrl,
-};
-```
-
-[[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/GetCourtsByClubAndSport200Response.md

@@ -1,26 +0,0 @@
-# GetCourtsByClubAndSport200Response
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**courts** | [**Array<CourtResponse>**](CourtResponse.md) |  | [optional] [default to undefined]
-**total** | **number** | Nombre total de terrains | [optional] [default to undefined]
-**clubId** | **string** | ID du club | [optional] [default to undefined]
-**sportId** | **string** | ID du sport | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetCourtsByClubAndSport200Response } from '@tennac-booking/sdk';
-
-const instance: GetCourtsByClubAndSport200Response = {
-    courts,
-    total,
-    clubId,
-    sportId,
-};
-```
-
-[[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/GetLastSixMonthsTurnover200ResponseInner.md

@@ -1,22 +0,0 @@
-# GetLastSixMonthsTurnover200ResponseInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**month** | **string** | Month name (3-letter format) | [optional] [default to undefined]
-**value** | **number** | Turnover amount for the month | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetLastSixMonthsTurnover200ResponseInner } from '@tennac-booking/sdk';
-
-const instance: GetLastSixMonthsTurnover200ResponseInner = {
-    month,
-    value,
-};
-```
-
-[[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/GetPublishedEventsByClubId200Response.md

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

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

@@ -1,34 +0,0 @@
-# InvoicesResponseInvoicesInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**billNumber** | **string** |  | [optional] [default to undefined]
-**date** | **string** |  | [optional] [default to undefined]
-**clientFirstName** | **string** |  | [optional] [default to undefined]
-**clientLastName** | **string** |  | [optional] [default to undefined]
-**clientEmail** | **string** |  | [optional] [default to undefined]
-**totalCost** | **number** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**linkToInvoicePDF** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { InvoicesResponseInvoicesInner } from '@tennac-booking/sdk';
-
-const instance: InvoicesResponseInvoicesInner = {
-    billNumber,
-    date,
-    clientFirstName,
-    clientLastName,
-    clientEmail,
-    totalCost,
-    status,
-    linkToInvoicePDF,
-};
-```
-
-[[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/InvoicesResponsePagination.md

@@ -1,26 +0,0 @@
-# InvoicesResponsePagination
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total** | **number** |  | [optional] [default to undefined]
-**page** | **number** |  | [optional] [default to undefined]
-**limit** | **number** |  | [optional] [default to undefined]
-**totalPages** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { InvoicesResponsePagination } from '@tennac-booking/sdk';
-
-const instance: InvoicesResponsePagination = {
-    total,
-    page,
-    limit,
-    totalPages,
-};
-```
-
-[[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/LevelBySportsItem.md

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

@@ -1,30 +0,0 @@
-# ManagerCancelBookingResponseBooking
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**cancellationReason** | **string** |  | [optional] [default to undefined]
-**cancelledAt** | **string** |  | [optional] [default to undefined]
-**cancelledBy** | **string** |  | [optional] [default to undefined]
-**cancelledByManager** | **boolean** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ManagerCancelBookingResponseBooking } from '@tennac-booking/sdk';
-
-const instance: ManagerCancelBookingResponseBooking = {
-    id,
-    status,
-    cancellationReason,
-    cancelledAt,
-    cancelledBy,
-    cancelledByManager,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)