@tennac-booking/sdk 1.0.11 → 1.0.13

package/docs/SportsApi.md

@@ -0,0 +1,229 @@
+# SportsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSport**](#createsport) | **POST** /api/sports | Crée un sport dans un club|
+|[**deleteSport**](#deletesport) | **DELETE** /api/sports/{id} | Supprime un sport|
+|[**getAllSports**](#getallsports) | **GET** /api/sports | Récupère la liste des sports d’un club|
+|[**updateSport**](#updatesport) | **PUT** /api/sports/{id} | Met à jour un sport|
+
+# **createSport**
+> Sport createSport(createSportRequest)
+
+
+### Example
+
+```typescript
+import {
+    SportsApi,
+    Configuration,
+    CreateSportRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SportsApi(configuration);
+
+let createSportRequest: CreateSportRequest; //
+
+const { status, data } = await apiInstance.createSport(
+    createSportRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createSportRequest** | **CreateSportRequest**|  | |
+
+
+### Return type
+
+**Sport**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Sport créé |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**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)
+
+# **deleteSport**
+> deleteSport()
+
+
+### Example
+
+```typescript
+import {
+    SportsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SportsApi(configuration);
+
+let id: string; //ID du sport (default to undefined)
+
+const { status, data } = await apiInstance.deleteSport(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du sport | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sport supprimé |  -  |
+|**401** | Non autorisé |  -  |
+|**404** | Sport 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)
+
+# **getAllSports**
+> Array<Sport> getAllSports(getAllSportsRequest)
+
+
+### Example
+
+```typescript
+import {
+    SportsApi,
+    Configuration,
+    GetAllSportsRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SportsApi(configuration);
+
+let getAllSportsRequest: GetAllSportsRequest; //
+
+const { status, data } = await apiInstance.getAllSports(
+    getAllSportsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **getAllSportsRequest** | **GetAllSportsRequest**|  | |
+
+
+### Return type
+
+**Array<Sport>**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Liste des sports |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**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)
+
+# **updateSport**
+> Sport updateSport(updateSportRequest)
+
+
+### Example
+
+```typescript
+import {
+    SportsApi,
+    Configuration,
+    UpdateSportRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SportsApi(configuration);
+
+let id: string; //ID du sport (default to undefined)
+let updateSportRequest: UpdateSportRequest; //
+
+const { status, data } = await apiInstance.updateSport(
+    id,
+    updateSportRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateSportRequest** | **UpdateSportRequest**|  | |
+| **id** | [**string**] | ID du sport | defaults to undefined|
+
+
+### Return type
+
+**Sport**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sport mis à jour |  -  |
+|**401** | Non autorisé |  -  |
+|**404** | Sport 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/SportsResponse.md

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

@@ -0,0 +1,22 @@
+# SubscribeToClubRequestBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clubId** | **string** | ID du club | [default to undefined]
+**roleId** | **string** | ID du rôle dans le club | [default to undefined]
+
+## Example
+
+```typescript
+import { SubscribeToClubRequestBody } from '@tennac-booking/sdk';
+
+const instance: SubscribeToClubRequestBody = {
+    clubId,
+    roleId,
+};
+```
+
+[[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

@@ -0,0 +1,36 @@
+# 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/SubscriptionPlanResponse.md

@@ -0,0 +1,36 @@
+# SubscriptionPlanResponse
+
+
+## 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 { SubscriptionPlanResponse } from '@tennac-booking/sdk';
+
+const instance: SubscriptionPlanResponse = {
+    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

@@ -0,0 +1,36 @@
+# 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/UpdateClubRequest.md

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

@@ -0,0 +1,24 @@
+# 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/UpdateCustomerRequestBody.md

@@ -0,0 +1,26 @@
+# UpdateCustomerRequestBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Nom du client | [optional] [default to undefined]
+**email** | **string** | Email du client | [optional] [default to undefined]
+**phone** | **string** | Téléphone du client | [optional] [default to undefined]
+**address** | [**UpdateCustomerRequestBodyAddress**](UpdateCustomerRequestBodyAddress.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCustomerRequestBody } from '@tennac-booking/sdk';
+
+const instance: UpdateCustomerRequestBody = {
+    name,
+    email,
+    phone,
+    address,
+};
+```
+
+[[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/UpdateCustomerRequestBodyAddress.md

@@ -0,0 +1,30 @@
+# UpdateCustomerRequestBodyAddress
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line1** | **string** |  | [optional] [default to undefined]
+**line2** | **string** |  | [optional] [default to undefined]
+**city** | **string** |  | [optional] [default to undefined]
+**state** | **string** |  | [optional] [default to undefined]
+**postal_code** | **string** |  | [optional] [default to undefined]
+**country** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCustomerRequestBodyAddress } from '@tennac-booking/sdk';
+
+const instance: UpdateCustomerRequestBodyAddress = {
+    line1,
+    line2,
+    city,
+    state,
+    postal_code,
+    country,
+};
+```
+
+[[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/UpdateCustomerResponse.md

@@ -0,0 +1,22 @@
+# UpdateCustomerResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Message de confirmation | [optional] [default to undefined]
+**customer** | [**UpdateCustomerResponseCustomer**](UpdateCustomerResponseCustomer.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCustomerResponse } from '@tennac-booking/sdk';
+
+const instance: UpdateCustomerResponse = {
+    message,
+    customer,
+};
+```
+
+[[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/UpdateCustomerResponseCustomer.md

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

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

@@ -0,0 +1,24 @@
+# UpdateSubscriptionPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**metadata** | **object** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateSubscriptionPlanRequest } from '@tennac-booking/sdk';
+
+const instance: UpdateSubscriptionPlanRequest = {
+    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)

package/docs/UpdateSubscriptionPlanResponse.md

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