@tennac-booking/sdk 1.0.11 → 1.0.12

package/docs/ClubRolesApi.md

@@ -0,0 +1,268 @@
+# ClubRolesApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createClubRole**](#createclubrole) | **POST** /api/club-roles | Crée un nouveau rôle de club|
+|[**deleteClubRole**](#deleteclubrole) | **DELETE** /api/club-roles/{id} | Supprime un rôle de club|
+|[**getAllClubRoles**](#getallclubroles) | **GET** /api/club-roles | Récupère tous les rôles de clubs|
+|[**getClubRoleById**](#getclubrolebyid) | **GET** /api/club-roles/{id} | Récupère un rôle de club par son ID|
+|[**updateClubRole**](#updateclubrole) | **PUT** /api/club-roles/{id} | Met à jour un rôle de club|
+
+# **createClubRole**
+> ClubRoleResponse createClubRole(createClubRoleRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    ClubRolesApi,
+    Configuration,
+    CreateClubRoleRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubRolesApi(configuration);
+
+let createClubRoleRequestBody: CreateClubRoleRequestBody; //
+
+const { status, data } = await apiInstance.createClubRole(
+    createClubRoleRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createClubRoleRequestBody** | **CreateClubRoleRequestBody**|  | |
+
+
+### Return type
+
+**ClubRoleResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Rôle de club créé |  -  |
+|**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)
+
+# **deleteClubRole**
+> DeleteClubRole200Response deleteClubRole()
+
+
+### Example
+
+```typescript
+import {
+    ClubRolesApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubRolesApi(configuration);
+
+let id: string; //ID du rôle de club (default to undefined)
+
+const { status, data } = await apiInstance.deleteClubRole(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du rôle de club | defaults to undefined|
+
+
+### Return type
+
+**DeleteClubRole200Response**
+
+### 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ôle de club supprimé |  -  |
+|**404** | Rôle de club non trouvé |  -  |
+|**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)
+
+# **getAllClubRoles**
+> Array<ClubRoleResponse> getAllClubRoles()
+
+
+### Example
+
+```typescript
+import {
+    ClubRolesApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubRolesApi(configuration);
+
+const { status, data } = await apiInstance.getAllClubRoles();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ClubRoleResponse>**
+
+### 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 de 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)
+
+# **getClubRoleById**
+> ClubRoleResponse getClubRoleById()
+
+
+### Example
+
+```typescript
+import {
+    ClubRolesApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubRolesApi(configuration);
+
+let id: string; //ID du rôle de club (default to undefined)
+
+const { status, data } = await apiInstance.getClubRoleById(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du rôle de club | defaults to undefined|
+
+
+### Return type
+
+**ClubRoleResponse**
+
+### 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ôle de club trouvé |  -  |
+|**404** | Rôle de club non trouvé |  -  |
+|**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)
+
+# **updateClubRole**
+> ClubRoleResponse updateClubRole(updateClubRoleRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    ClubRolesApi,
+    Configuration,
+    UpdateClubRoleRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubRolesApi(configuration);
+
+let id: string; //ID du rôle de club (default to undefined)
+let updateClubRoleRequestBody: UpdateClubRoleRequestBody; //
+
+const { status, data } = await apiInstance.updateClubRole(
+    id,
+    updateClubRoleRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateClubRoleRequestBody** | **UpdateClubRoleRequestBody**|  | |
+| **id** | [**string**] | ID du rôle de club | defaults to undefined|
+
+
+### Return type
+
+**ClubRoleResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Rôle de club mis à jour |  -  |
+|**404** | Rôle de club non trouvé |  -  |
+|**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/ClubRolesResponse.md

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

@@ -0,0 +1,28 @@
+# ClubSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clubId** | **string** |  | [default to undefined]
+**reservationStartTime** | **string** |  | [optional] [default to undefined]
+**reservationEndTime** | **string** |  | [optional] [default to undefined]
+**maxSimultaneousReservations** | **number** |  | [optional] [default to undefined]
+**allowWeekendReservations** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClubSettings } from '@tennac-booking/sdk';
+
+const instance: ClubSettings = {
+    clubId,
+    reservationStartTime,
+    reservationEndTime,
+    maxSimultaneousReservations,
+    allowWeekendReservations,
+};
+```
+
+[[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/ClubSettingsApi.md

@@ -0,0 +1,227 @@
+# ClubSettingsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createClubSettings**](#createclubsettings) | **POST** /api/club-settings | Crée les paramètres d’un club|
+|[**deleteClubSettings**](#deleteclubsettings) | **DELETE** /api/club-settings | Supprime les paramètres d’un club|
+|[**getClubSettings**](#getclubsettings) | **GET** /api/club-settings | Récupère les paramètres d’un club|
+|[**updateClubSettings**](#updateclubsettings) | **PUT** /api/club-settings | Met à jour les paramètres d’un club|
+
+# **createClubSettings**
+> ClubSettings createClubSettings(clubSettings)
+
+
+### Example
+
+```typescript
+import {
+    ClubSettingsApi,
+    Configuration,
+    ClubSettings
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSettingsApi(configuration);
+
+let clubSettings: ClubSettings; //
+
+const { status, data } = await apiInstance.createClubSettings(
+    clubSettings
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubSettings** | **ClubSettings**|  | |
+
+
+### Return type
+
+**ClubSettings**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Paramètres créés |  -  |
+|**401** | Non autorisé |  -  |
+|**409** | Paramètres déjà existants |  -  |
+|**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)
+
+# **deleteClubSettings**
+> deleteClubSettings(getClubSettingsRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubSettingsApi,
+    Configuration,
+    GetClubSettingsRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSettingsApi(configuration);
+
+let getClubSettingsRequest: GetClubSettingsRequest; //
+
+const { status, data } = await apiInstance.deleteClubSettings(
+    getClubSettingsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **getClubSettingsRequest** | **GetClubSettingsRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paramètres supprimés |  -  |
+|**401** | Non autorisé |  -  |
+|**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)
+
+# **getClubSettings**
+> ClubSettings getClubSettings(getClubSettingsRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubSettingsApi,
+    Configuration,
+    GetClubSettingsRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSettingsApi(configuration);
+
+let getClubSettingsRequest: GetClubSettingsRequest; //
+
+const { status, data } = await apiInstance.getClubSettings(
+    getClubSettingsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **getClubSettingsRequest** | **GetClubSettingsRequest**|  | |
+
+
+### Return type
+
+**ClubSettings**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paramètres du club |  -  |
+|**401** | Non autorisé |  -  |
+|**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)
+
+# **updateClubSettings**
+> ClubSettings updateClubSettings(clubSettings)
+
+
+### Example
+
+```typescript
+import {
+    ClubSettingsApi,
+    Configuration,
+    ClubSettings
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSettingsApi(configuration);
+
+let clubSettings: ClubSettings; //
+
+const { status, data } = await apiInstance.updateClubSettings(
+    clubSettings
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubSettings** | **ClubSettings**|  | |
+
+
+### Return type
+
+**ClubSettings**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paramètres mis à jour |  -  |
+|**401** | Non autorisé |  -  |
+|**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)
+