@tennac-booking/sdk 1.0.11 → 1.0.12

package/docs/ClubsApi.md

@@ -0,0 +1,432 @@
+# ClubsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addClubMember**](#addclubmember) | **PUT** /api/clubs/{id}/add_members | Ajouter un membre à un club|
+|[**createClub**](#createclub) | **POST** /api/clubs | Créer un nouveau club|
+|[**deleteClub**](#deleteclub) | **DELETE** /api/clubs/{id} | Supprimer un club|
+|[**getAllClubs**](#getallclubs) | **GET** /api/clubs | Récupérer tous les clubs|
+|[**getClubInfo**](#getclubinfo) | **GET** /api/clubs/{id} | Récupérer les informations d\'un club|
+|[**getClubMembers**](#getclubmembers) | **GET** /api/clubs/{id}/members | Récupérer les membres d\'un club|
+|[**getClubRoles**](#getclubroles) | **GET** /api/clubs/{id}/roles | Récupérer les rôles d\'un club|
+|[**updateClub**](#updateclub) | **PUT** /api/clubs/{id} | Mettre à jour un club existant|
+
+# **addClubMember**
+> AddClubMemberResponse addClubMember(addClubMemberRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration,
+    AddClubMemberRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let addClubMemberRequest: AddClubMemberRequest; //
+
+const { status, data } = await apiInstance.addClubMember(
+    id,
+    addClubMemberRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addClubMemberRequest** | **AddClubMemberRequest**|  | |
+| **id** | [**string**] | ID du club | defaults to undefined|
+
+
+### Return type
+
+**AddClubMemberResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Membre ajouté avec succès |  -  |
+|**400** | Requête invalide |  -  |
+|**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)
+
+# **createClub**
+> ClubResponse createClub(createClubRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration,
+    CreateClubRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let createClubRequest: CreateClubRequest; //
+
+const { status, data } = await apiInstance.createClub(
+    createClubRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createClubRequest** | **CreateClubRequest**|  | |
+
+
+### Return type
+
+**ClubResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Club créé avec succès |  -  |
+|**400** | Requête invalide |  -  |
+|**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)
+
+# **deleteClub**
+> DeleteClub200Response deleteClub()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+
+const { status, data } = await apiInstance.deleteClub(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+
+
+### Return type
+
+**DeleteClub200Response**
+
+### 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 supprimé avec succès |  -  |
+|**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)
+
+# **getAllClubs**
+> ClubListResponse getAllClubs()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+const { status, data } = await apiInstance.getAllClubs();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ClubListResponse**
+
+### 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 clubs |  -  |
+|**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)
+
+# **getClubInfo**
+> ClubInfoResponse getClubInfo()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+
+const { status, data } = await apiInstance.getClubInfo(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+
+
+### Return type
+
+**ClubInfoResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Informations du club |  -  |
+|**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)
+
+# **getClubMembers**
+> ClubMembersResponse getClubMembers()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+
+const { status, data } = await apiInstance.getClubMembers(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+
+
+### Return type
+
+**ClubMembersResponse**
+
+### 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 membres 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)
+
+# **getClubRoles**
+> ClubRolesResponse getClubRoles()
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+
+const { status, data } = await apiInstance.getClubRoles(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+
+
+### Return type
+
+**ClubRolesResponse**
+
+### 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 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)
+
+# **updateClub**
+> ClubResponse updateClub(updateClubRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubsApi,
+    Configuration,
+    UpdateClubRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let updateClubRequest: UpdateClubRequest; //
+
+const { status, data } = await apiInstance.updateClub(
+    id,
+    updateClubRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateClubRequest** | **UpdateClubRequest**|  | |
+| **id** | [**string**] | ID du club | defaults to undefined|
+
+
+### Return type
+
+**ClubResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Club mis à jour avec succès |  -  |
+|**400** | Requête invalide |  -  |
+|**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)
+

package/docs/CourtResponse.md

@@ -0,0 +1,44 @@
+# CourtResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**status** | [**CourtStatus**](CourtStatus.md) |  | [optional] [default to undefined]
+**comments** | **string** |  | [optional] [default to undefined]
+**pricePerSlot** | **number** |  | [optional] [default to undefined]
+**slotDefaultDuration** | **number** |  | [optional] [default to undefined]
+**startTimeInTheDayInMinutes** | **number** |  | [optional] [default to undefined]
+**endTimeInTheDayInMinutes** | **number** |  | [optional] [default to undefined]
+**clubId** | **string** |  | [optional] [default to undefined]
+**sportId** | **string** |  | [optional] [default to undefined]
+**isActive** | **boolean** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CourtResponse } from '@tennac-booking/sdk';
+
+const instance: CourtResponse = {
+    id,
+    name,
+    status,
+    comments,
+    pricePerSlot,
+    slotDefaultDuration,
+    startTimeInTheDayInMinutes,
+    endTimeInTheDayInMinutes,
+    clubId,
+    sportId,
+    isActive,
+    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/CourtsResponse.md

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

@@ -0,0 +1,28 @@
+# CreateBookingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userId** | **string** | ID de l\'utilisateur créateur de la réservation | [default to undefined]
+**slotId** | **string** | ID du créneau à réserver | [default to undefined]
+**players** | [**Array<PlayerWithPaymentMethod>**](PlayerWithPaymentMethod.md) | Liste des joueurs avec leurs méthodes de paiement | [default to undefined]
+**isCreatorPayingAll** | **boolean** | Indique si le créateur paie pour tous les joueurs | [optional] [default to false]
+**paymentMethod** | [**PaymentMethod**](PaymentMethod.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateBookingRequest } from '@tennac-booking/sdk';
+
+const instance: CreateBookingRequest = {
+    userId,
+    slotId,
+    players,
+    isCreatorPayingAll,
+    paymentMethod,
+};
+```
+
+[[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/CreateClubRequest.md

@@ -0,0 +1,38 @@
+# CreateClubRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**address** | **string** |  | [default to undefined]
+**city** | **string** |  | [default to undefined]
+**zipCode** | **string** |  | [default to undefined]
+**country** | **string** |  | [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**website** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**logo** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateClubRequest } from '@tennac-booking/sdk';
+
+const instance: CreateClubRequest = {
+    name,
+    address,
+    city,
+    zipCode,
+    country,
+    phone,
+    email,
+    website,
+    description,
+    logo,
+};
+```
+
+[[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/CreateClubRoleRequestBody.md

@@ -0,0 +1,24 @@
+# CreateClubRoleRequestBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Nom du rôle à créer (ex: joueur, coach, admin) | [default to undefined]
+**description** | **string** | Description du rôle | [default to undefined]
+**permissions** | **Array<string>** | Permissions associées à ce rôle | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateClubRoleRequestBody } from '@tennac-booking/sdk';
+
+const instance: CreateClubRoleRequestBody = {
+    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/CreateCourtRequest.md

@@ -0,0 +1,34 @@
+# CreateCourtRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**status** | [**CourtStatus**](CourtStatus.md) |  | [default to undefined]
+**comments** | **string** |  | [optional] [default to undefined]
+**pricePerSlot** | **number** |  | [default to undefined]
+**slotDefaultDuration** | **number** |  | [default to undefined]
+**startTimeInTheDayInMinutes** | **number** |  | [default to undefined]
+**endTimeInTheDayInMinutes** | **number** |  | [default to undefined]
+**sportId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCourtRequest } from '@tennac-booking/sdk';
+
+const instance: CreateCourtRequest = {
+    name,
+    status,
+    comments,
+    pricePerSlot,
+    slotDefaultDuration,
+    startTimeInTheDayInMinutes,
+    endTimeInTheDayInMinutes,
+    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/CreatePriceRequest.md

@@ -0,0 +1,26 @@
+# CreatePriceRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** |  | [default to undefined]
+**currency** | **string** |  | [default to 'eur']
+**interval** | **string** |  | [default to undefined]
+**intervalCount** | **number** |  | [optional] [default to 1]
+
+## Example
+
+```typescript
+import { CreatePriceRequest } from '@tennac-booking/sdk';
+
+const instance: CreatePriceRequest = {
+    amount,
+    currency,
+    interval,
+    intervalCount,
+};
+```
+
+[[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/CreateSportRequest.md

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

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